Simplify doc structure implementation

vert-x3 · Nov 29, 2024 · b6c3235 · b6c3235
1 parent 2de238c
commit b6c3235
Show file tree

Hide file tree

Showing 7 changed files with 13 additions and 24 deletions.
diff --git a/asciidoc/chapters/assembly_mg_what-is-new-and-different-in-vertx-5.adoc b/asciidoc/chapters/assembly_mg_what-is-new-and-different-in-vertx-5.adoc
diff --git a/asciidoc/index.adoc b/asciidoc/index.adoc
@@ -6,4 +6,14 @@ Depending on the modules used in your application, you can read the relevant sec
 
 include::modules/con_mg-about-vertx.adoc[leveloffset=+1]
 
-include::chapters/assembly_mg_what-is-new-and-different-in-vertx-5.adoc[leveloffset=+1]
+== What's changed in {VertX} {v5}
+
+:context: what-is-new-and-different-in-vertx-5
+
+This section explains the fundamental differences between {VertX} {v5} and {v4x} releases.
+
+include::modules/con_mg_vertx_cli_removal.adoc[leveloffset=+1]
+
+include::modules/con_mg_cli_framework_deprecation.adoc[leveloffset=+1]
+
+include::modules/con_mg_handling_deprecations_and_removals.adoc[leveloffset=+1]
diff --git a/asciidoc/modules/con_mg-about-vertx.adoc b/asciidoc/modules/con_mg-about-vertx.adoc
@@ -1,4 +1,3 @@
-[id='about-vertx_{context}']
 = About {VertX}
 
 {VertX} is a toolkit used for creating reactive, non-blocking, and asynchronous applications that run on Java Virtual Machine. (JVM). It contains several components that help you create reactive applications. It is designed to be cloud-native.

diff --git a/asciidoc/modules/con_mg_cli_framework_deprecation.adoc b/asciidoc/modules/con_mg_cli_framework_deprecation.adoc
@@ -1,4 +1,3 @@
-[id="cli_framework_deprecation_{context}"]
 = CLI framework deprecation
 
 The CLI framework is deprecated in {VertX} {v5}.

diff --git a/asciidoc/modules/con_mg_handling_deprecations_and_removals.adoc b/asciidoc/modules/con_mg_handling_deprecations_and_removals.adoc
@@ -1,4 +1,3 @@
-[id="handling_deprecations_and_removals_{context}"]
 = Handling deprecations and removals
 
 Some features and functions have been deprecated or removed in {VertX} {v5}. Before you migrate your applications to {VertX} {v5}, check for deprecations and removals.

diff --git a/asciidoc/modules/con_mg_vertx_cli_removal.adoc b/asciidoc/modules/con_mg_vertx_cli_removal.adoc
@@ -1,5 +1,4 @@
-[id="vertx_cli_removal_{context}"]
-= `vertx` command-line tool removal
+= vertx command-line tool removal
 
 The `vertx` command-line tool has been removed in {VertX} {v5}.
 

diff --git a/pom.xml b/pom.xml
@@ -23,7 +23,7 @@
   <artifactId>vertx-5-migration-guide</artifactId>
   <version>1.0.0-SNASHOT</version>
 
-  <name>Vert.x 4 Migration Guide</name>
+  <name>Vert.x 5 Migration Guide</name>
 
   <licenses>
     <license>