This is an automated email from the ASF dual-hosted git repository.
ntimofeev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne.git
The following commit(s) were added to refs/heads/master by this push:
new 58a6b2d97 CAY-2849 Switch documentation to
`hugo-asciidoctorj-extension`
58a6b2d97 is described below
commit 58a6b2d97b091532ea8f847bd40a6380cb496f82
Author: Nikita Timofeev <[email protected]>
AuthorDate: Thu Apr 11 13:46:46 2024 +0400
CAY-2849 Switch documentation to `hugo-asciidoctorj-extension`
---
.../cayenne/asciidoc/CayennePostProcessor.java | 2 ++
docs/asciidoc/cayenne-guide/pom.xml | 8 ++++----
.../src/docs/asciidoc/_cayenne-guide/header.html | 13 ++++--------
.../{header.html => multipage-header.html} | 15 ++++----------
.../asciidoc/_cayenne-guide/part1/modeler.adoc | 2 +-
.../_cayenne-guide/part4/revEngineering.adoc | 4 ++--
.../docs/asciidoc/_cayenne-guide/part5/crypto.adoc | 2 +-
.../src/docs/asciidoc/cayenne-guide.adoc | 10 ++++++---
docs/asciidoc/getting-started-db-first/pom.xml | 9 ++++----
.../docs/asciidoc/getting-started-db-first.adoc | 3 +--
docs/asciidoc/getting-started-guide/pom.xml | 13 ++++++------
.../src/docs/asciidoc/getting-started-guide.adoc | 3 +--
docs/asciidoc/pom.xml | 24 ++++++++++++++++++++--
docs/asciidoc/upgrade-guide/pom.xml | 8 ++++----
.../docs/asciidoc/_upgrade-guide/new-features.adoc | 1 +
.../src/docs/asciidoc/upgrade-guide.adoc | 3 +--
16 files changed, 65 insertions(+), 55 deletions(-)
diff --git
a/docs/asciidoc/cayenne-asciidoc-extension/src/main/java/org/apache/cayenne/asciidoc/CayennePostProcessor.java
b/docs/asciidoc/cayenne-asciidoc-extension/src/main/java/org/apache/cayenne/asciidoc/CayennePostProcessor.java
index 67ccaa416..374703ee3 100644
---
a/docs/asciidoc/cayenne-asciidoc-extension/src/main/java/org/apache/cayenne/asciidoc/CayennePostProcessor.java
+++
b/docs/asciidoc/cayenne-asciidoc-extension/src/main/java/org/apache/cayenne/asciidoc/CayennePostProcessor.java
@@ -49,7 +49,9 @@ import org.jsoup.Jsoup;
* </ul>
*
* @since 4.1
+ * @deprecated in favour of io.bootique.tools.asciidoctorj.HugoExtension
*/
+@Deprecated
public class CayennePostProcessor extends Postprocessor {
private static final String FRONT_MATTER = "front-matter";
diff --git a/docs/asciidoc/cayenne-guide/pom.xml
b/docs/asciidoc/cayenne-guide/pom.xml
index d93a3a5e9..9fc94cc9a 100644
--- a/docs/asciidoc/cayenne-guide/pom.xml
+++ b/docs/asciidoc/cayenne-guide/pom.xml
@@ -38,9 +38,9 @@
<artifactId>asciidoctor-maven-plugin</artifactId>
<dependencies>
<dependency>
- <groupId>org.apache.cayenne.docs</groupId>
- <artifactId>cayenne-asciidoc-extension</artifactId>
- <version>${project.version}</version>
+ <groupId>io.bootique.tools</groupId>
+ <artifactId>hugo-asciidoctorj-extension</artifactId>
+ <version>1.0-M1</version>
</dependency>
</dependencies>
@@ -58,7 +58,7 @@
<outputDirectory>${project.build.directory}/tmp/</outputDirectory>
<extensions>
<extension>
-
<className>org.apache.cayenne.asciidoc.CayennePostProcessor</className>
+
<className>io.bootique.tools.asciidoctorj.HugoExtension</className>
</extension>
</extensions>
<attributes>
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/header.html
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/header.html
index b217d5944..1e067a071 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/header.html
+++ b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/header.html
@@ -16,15 +16,10 @@
# specific language governing permissions and limitations
# under the License.
-title: "Cayenne Guide"
-description: "Cayenne Guide"
-cayenneVersion: "4.2"
-weight: 20
-menu:
- footer:
- weight: 30
- parent: docs
- name: "Cayenne Guide (4.2)"
+title: "Cayenne Guide 5.0"
+description: "Cayenne Guide 5.0"
+cayenneVersion: "5.0"
+weight: 30
---
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/header.html
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/multipage-header.html
similarity index 81%
copy from
docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/header.html
copy to
docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/multipage-header.html
index b217d5944..1235f42a2 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/header.html
+++
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/multipage-header.html
@@ -16,15 +16,8 @@
# specific language governing permissions and limitations
# under the License.
-title: "Cayenne Guide"
-description: "Cayenne Guide"
-cayenneVersion: "4.2"
-weight: 20
-menu:
- footer:
- weight: 30
- parent: docs
- name: "Cayenne Guide (4.2)"
+title: "Cayenne Guide 5.0 ยท {title}"
+description: "Cayenne Guide 5.0, {title}"
+cayenneVersion: "5.0"
+cayenneNoToc: true
---
-
-
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part1/modeler.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part1/modeler.adoc
index 0ed01eb7b..674ee30fe 100644
---
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part1/modeler.adoc
+++
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part1/modeler.adoc
@@ -63,4 +63,4 @@ Cayenne will delegate PK generation to database (e.g. auto
increment fields on M
Strategy should be set per each `DbEntity` independently.
-image::../images/db-entity-pk.png[align="center"]
+image::../../images/db-entity-pk.png[align="center"]
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part4/revEngineering.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part4/revEngineering.adoc
index 153bba400..4f9c3fb05 100644
---
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part4/revEngineering.adoc
+++
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part4/revEngineering.adoc
@@ -21,7 +21,7 @@ You can find reverse engineering tool in dataMap view on
*DbImport Tab*.
==== Reverse engineering options
-image::../images/re-modeler-reverseengineering-dialog.png[align="center"]
+image::../../images/re-modeler-reverseengineering-dialog.png[align="center"]
Reverse Engineering dialog.
@@ -64,7 +64,7 @@ Here is a list of options to tune what will be processed by
reverse engineering:
Then you click `Run Import` or `Configure Connection` to set DataSource.
If you don't have any DataSource yet you can create one from this menu.
-image::../images/re-modeler-datasource-select.png[align="center"]
+image::../../images/re-modeler-datasource-select.png[align="center"]
Datasource selection dialog.
diff --git
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part5/crypto.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part5/crypto.adoc
index ad6242364..6652153d0 100644
---
a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part5/crypto.adoc
+++
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part5/crypto.adoc
@@ -63,7 +63,7 @@ CayenneRuntime runtime = CayenneRuntime.builder()
Here is an example of how `ObjEntity` with two encrypted and two unencrypted
properties can look like:
-image::../images/ext-crypto-obj-entity.png[align="left"]
+image::../../images/ext-crypto-obj-entity.png[align="left"]
===== Setup keystore
diff --git a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/cayenne-guide.adoc
b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/cayenne-guide.adoc
index 6ffabfd28..11c152820 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/cayenne-guide.adoc
+++ b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/cayenne-guide.adoc
@@ -16,9 +16,13 @@
// enable section numbering, limiting depth to 2
:sectnums:
:sectnumlevels: 2
-// use custom header
-:cayenne-header: _cayenne-guide/header.html
-:cayenne-header-position: body
+
+// header + multipage
+:hugo-header: _cayenne-guide/header.html
+:hugo-multipage: true
+:hugo-multipage-level: 2
+:hugo-multipage-header: _cayenne-guide/multipage-header.html
+:hugo-multipage-ref: /docs/{project-major-version}/
// customize final layout
//:linkcss:
// base path to java code include
diff --git a/docs/asciidoc/getting-started-db-first/pom.xml
b/docs/asciidoc/getting-started-db-first/pom.xml
index a338bb3e0..ee418ceba 100644
--- a/docs/asciidoc/getting-started-db-first/pom.xml
+++ b/docs/asciidoc/getting-started-db-first/pom.xml
@@ -37,11 +37,10 @@
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<dependencies>
- <!-- Using own extension to inject custom headers -->
<dependency>
- <groupId>org.apache.cayenne.docs</groupId>
- <artifactId>cayenne-asciidoc-extension</artifactId>
- <version>${project.version}</version>
+ <groupId>io.bootique.tools</groupId>
+ <artifactId>hugo-asciidoctorj-extension</artifactId>
+ <version>1.0-M1</version>
</dependency>
</dependencies>
@@ -60,7 +59,7 @@
<!-- this will inject header with "front-matter"
markup -->
<extensions>
<extension>
-
<className>org.apache.cayenne.asciidoc.CayennePostProcessor</className>
+
<className>io.bootique.tools.asciidoctorj.HugoExtension</className>
</extension>
</extensions>
<attributes>
diff --git
a/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/getting-started-db-first.adoc
b/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/getting-started-db-first.adoc
index 66285ad38..72232ff7f 100644
---
a/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/getting-started-db-first.adoc
+++
b/docs/asciidoc/getting-started-db-first/src/docs/asciidoc/getting-started-db-first.adoc
@@ -17,8 +17,7 @@
:sectnums:
:sectnumlevels: 2
// use custom header
-:cayenne-header: _getting-started-db-first/header.html
-:cayenne-header-position: body
+:hugo-header: _getting-started-db-first/header.html
// base path to java code include
:cayenne-root: {basedir}/../../..
:java-include-dir:
{cayenne-root}/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial
diff --git a/docs/asciidoc/getting-started-guide/pom.xml
b/docs/asciidoc/getting-started-guide/pom.xml
index 4ad5f7563..af757dec5 100644
--- a/docs/asciidoc/getting-started-guide/pom.xml
+++ b/docs/asciidoc/getting-started-guide/pom.xml
@@ -37,11 +37,10 @@
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<dependencies>
- <!-- Using own extension to inject custom headers -->
<dependency>
- <groupId>org.apache.cayenne.docs</groupId>
- <artifactId>cayenne-asciidoc-extension</artifactId>
- <version>${project.version}</version>
+ <groupId>io.bootique.tools</groupId>
+ <artifactId>hugo-asciidoctorj-extension</artifactId>
+ <version>1.0-M1</version>
</dependency>
</dependencies>
@@ -60,7 +59,7 @@
<!-- this will inject header with "front-matter"
markup -->
<extensions>
<extension>
-
<className>org.apache.cayenne.asciidoc.CayennePostProcessor</className>
+
<className>io.bootique.tools.asciidoctorj.HugoExtension</className>
</extension>
</extensions>
<attributes>
@@ -91,10 +90,10 @@
</goals>
<configuration>
<backend>html5</backend>
-
<sourceHighlighter>coderay</sourceHighlighter>
<embedAssets>true</embedAssets>
<attributes>
<toc>left</toc>
+
<sourceHighlighter>coderay</sourceHighlighter>
</attributes>
</configuration>
</execution>
@@ -108,10 +107,10 @@
</goals>
<configuration>
<backend>pdf</backend>
-
<sourceHighlighter>coderay</sourceHighlighter>
<attributes>
<pagenums />
<toc />
+
<sourceHighlighter>coderay</sourceHighlighter>
</attributes>
</configuration>
</execution>
diff --git
a/docs/asciidoc/getting-started-guide/src/docs/asciidoc/getting-started-guide.adoc
b/docs/asciidoc/getting-started-guide/src/docs/asciidoc/getting-started-guide.adoc
index 5725bd762..1434f9525 100644
---
a/docs/asciidoc/getting-started-guide/src/docs/asciidoc/getting-started-guide.adoc
+++
b/docs/asciidoc/getting-started-guide/src/docs/asciidoc/getting-started-guide.adoc
@@ -17,8 +17,7 @@
:sectnums:
:sectnumlevels: 2
// use custom header
-:cayenne-header: _getting-started-guide/header.html
-:cayenne-header-position: body
+:hugo-header: _getting-started-guide/header.html
// base path to java code include
:cayenne-root: {basedir}/../../..
:java-include-dir:
{cayenne-root}/tutorials/tutorial/src/main/java/org/apache/cayenne/tutorial
diff --git a/docs/asciidoc/pom.xml b/docs/asciidoc/pom.xml
index b0896a967..ef1ac1c73 100644
--- a/docs/asciidoc/pom.xml
+++ b/docs/asciidoc/pom.xml
@@ -41,8 +41,8 @@
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
- <asciidoctorj.version>2.5.4</asciidoctorj.version>
-
<asciidoctor.maven.plugin.version>2.2.2</asciidoctor.maven.plugin.version>
+ <asciidoctorj.version>2.5.12</asciidoctorj.version>
+
<asciidoctor.maven.plugin.version>2.2.6</asciidoctor.maven.plugin.version>
<asciidoctorj.pdf.version>2.1.4</asciidoctorj.pdf.version>
<cayenne.version>${project.version}</cayenne.version>
<cayenne.major.version>5.0</cayenne.major.version>
@@ -137,6 +137,26 @@
</configuration>
</execution>
+ <execution>
+ <id>copy additional docs for site</id>
+ <phase>package</phase>
+ <goals>
+ <goal>copy-resources</goal>
+ </goals>
+
+ <configuration>
+
<outputDirectory>${project.build.directory}/site/${project.artifactId}/</outputDirectory>
+ <resources>
+ <resource>
+
<directory>${project.build.directory}/tmp/${project.artifactId}/</directory>
+ <includes>
+ <include>*.html</include>
+ </includes>
+ </resource>
+ </resources>
+ </configuration>
+ </execution>
+
<execution>
<id>copy images for site</id>
<phase>package</phase>
diff --git a/docs/asciidoc/upgrade-guide/pom.xml
b/docs/asciidoc/upgrade-guide/pom.xml
index 8eb0883fe..70579a05c 100644
--- a/docs/asciidoc/upgrade-guide/pom.xml
+++ b/docs/asciidoc/upgrade-guide/pom.xml
@@ -36,9 +36,9 @@
<artifactId>asciidoctor-maven-plugin</artifactId>
<dependencies>
<dependency>
- <groupId>org.apache.cayenne.docs</groupId>
- <artifactId>cayenne-asciidoc-extension</artifactId>
- <version>${project.version}</version>
+ <groupId>io.bootique.tools</groupId>
+ <artifactId>hugo-asciidoctorj-extension</artifactId>
+ <version>1.0-M1</version>
</dependency>
</dependencies>
@@ -56,7 +56,7 @@
<outputDirectory>${project.build.directory}/tmp/</outputDirectory>
<extensions>
<extension>
-
<className>org.apache.cayenne.asciidoc.CayennePostProcessor</className>
+
<className>io.bootique.tools.asciidoctorj.HugoExtension</className>
</extension>
</extensions>
<attributes>
diff --git
a/docs/asciidoc/upgrade-guide/src/docs/asciidoc/_upgrade-guide/new-features.adoc
b/docs/asciidoc/upgrade-guide/src/docs/asciidoc/_upgrade-guide/new-features.adoc
index 0af4adf16..5bccf3426 100644
---
a/docs/asciidoc/upgrade-guide/src/docs/asciidoc/_upgrade-guide/new-features.adoc
+++
b/docs/asciidoc/upgrade-guide/src/docs/asciidoc/_upgrade-guide/new-features.adoc
@@ -18,3 +18,4 @@ Minimum required JDK version is 11 or newer.
Cayenne 5.0 is fully tested with Java 11, 17 and 21.
== New Features
+
diff --git a/docs/asciidoc/upgrade-guide/src/docs/asciidoc/upgrade-guide.adoc
b/docs/asciidoc/upgrade-guide/src/docs/asciidoc/upgrade-guide.adoc
index b487695fc..fe8c4a1dd 100644
--- a/docs/asciidoc/upgrade-guide/src/docs/asciidoc/upgrade-guide.adoc
+++ b/docs/asciidoc/upgrade-guide/src/docs/asciidoc/upgrade-guide.adoc
@@ -17,8 +17,7 @@
:sectnums:
:sectnumlevels: 2
// use custom header
-:cayenne-header: _upgrade-guide/header.html
-:cayenne-header-position: body
+:hugo-header: _upgrade-guide/header.html
// base path to java code include
:cayenne-root: {basedir}/../../..
