fix(website): Fixed Edit Button, Page Attributes and Apache Links

apache · Nov 12, 2024 · f2372e1 · f2372e1
1 parent a3266ed
commit f2372e1
Show file tree

Hide file tree

Showing 131 changed files with 238 additions and 377 deletions.
diff --git a/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy b/plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy
@@ -102,7 +102,7 @@ for (final def protocolCode in plcDriverManager.getProtocolCodes()) {
         "<dependency>\n" +
         "  <groupId>org.apache.plc4x</groupId>\n" +
         "  <artifactId>" + moduleName + "</artifactId>\n" +
-        "  <version>{current-last-released-version}</version>\n" +
+        "  <version>{page-component-version}</version>\n" +
         "</dependency>\n" +
         "----"
     if(driver.metadata.defaultTransportCode.isPresent()) {

diff --git a/website/antora-playbook.yml b/website/antora-playbook.yml
@@ -22,7 +22,7 @@ content:
   sources:   
   - url: ../..
     branches: HEAD
-    start_path: website/target/asciidoc
+    start_path: website/asciidoc
 ui: 
   bundle:
     url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable

diff --git a/website/asciidoc/antora.yml b/website/asciidoc/antora.yml
@@ -17,11 +17,10 @@
 # under the License.
 #
 name: plc4x
-version: 'latest'
+version: '0.13.0-SNAPSHOT'
 prerelease: True
 title: PLC4X
 nav:
 - modules/ROOT/nav.adoc
 - modules/users/nav.adoc
 - modules/developers/nav.adoc
-- modules/apache/nav.adoc
diff --git a/website/asciidoc/modules/apache/nav.adoc b/website/asciidoc/modules/apache/nav.adoc
diff --git a/website/asciidoc/modules/apache/pages/index.adoc b/website/asciidoc/modules/apache/pages/index.adoc
diff --git a/website/asciidoc/modules/developers/pages/architecture.adoc b/website/asciidoc/modules/developers/pages/architecture.adoc
@@ -19,7 +19,7 @@
 
 == Simple case
 
-include::partial$pom.adoc[]
+
 
 In this simple case, an application asks the DriverManager to forward a connection creation to the corresponding Driver implementation, which then creates both a Connection and a MessageCodec instance. The Connection is the logical link between the connection state and the MessageCodec.
 A MessageCodec uses a TransportInstance to communicate with the target device.

diff --git a/website/asciidoc/modules/developers/pages/building.adoc b/website/asciidoc/modules/developers/pages/building.adoc
@@ -17,8 +17,6 @@
 
 = Building PLC4X
 
-include::partial$pom.adoc[]
-
 PLC4X is built with `Apache Maven` and we have tried to make the build as simple as possible.
 
 However PLC4X aims at providing means to communicate with PLCs of multiple vendors using a shared API but also in a variety of different languages.
@@ -158,8 +156,8 @@ repositories {
 }
 
 dependencies {
-    implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{current-last-released-version}'
-    implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{current-last-released-version}'
-    implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{current-last-released-version}'
+    implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{page-component-version}'
+    implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{page-component-version}'
+    implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{page-component-version}'
 }
 ----
diff --git a/website/asciidoc/modules/developers/pages/code-gen/index.adoc b/website/asciidoc/modules/developers/pages/code-gen/index.adoc
@@ -18,7 +18,7 @@
 
 = Code Generation
 
-include::partial$pom.adoc[]
+
 
 As hand-writing code for a lot of drivers in multiple languages would be quite a nightmare, we have invested a very large amount of time into finding a way to automate this.
 
@@ -199,7 +199,7 @@ Here's an example of a driver pom for building a `S7` driver for `java`:
   <parent>
     <groupId>org.apache.plc4x.plugins</groupId>
     <artifactId>plc4x-code-generation</artifactId>
-    <version>{current-last-released-version}</version>
+    <version>{page-component-version}</version>
   </parent>
 
   <artifactId>test-java-s7-driver</artifactId>
@@ -231,21 +231,21 @@ Here's an example of a driver pom for building a `S7` driver for `java`:
     <dependency>
       <groupId>org.apache.plc4x.plugins</groupId>
       <artifactId>plc4x-code-generation-driver-base-java</artifactId>
-      <version>{current-last-released-version}</version>
+      <version>{page-component-version}</version>
     </dependency>
 
     <dependency>
       <groupId>org.apache.plc4x.plugins</groupId>
       <artifactId>plc4x-code-generation-language-java</artifactId>
-      <version>{current-last-released-version}</version>
+      <version>{page-component-version}</version>
       <!-- Scope is 'provided' as this way it's not shipped with the driver -->
       <scope>provided</scope>
     </dependency>
 
     <dependency>
       <groupId>org.apache.plc4x.plugins</groupId>
       <artifactId>plc4x-code-generation-protocol-s7</artifactId>
-      <version>{current-last-released-version}</version>
+      <version>{page-component-version}</version>
       <!-- Scope is 'provided' as this way it's not shipped with the driver -->
       <scope>provided</scope>
     </dependency>
@@ -263,7 +263,7 @@ The dependency:
     <dependency>
       <groupId>org.apache.plc4x.plugins</groupId>
       <artifactId>plc4x-code-generation-driver-base-java</artifactId>
-      <version>{current-last-released-version}</version>
+      <version>{page-component-version}</version>
     </dependency>
 ....
 
@@ -276,7 +276,7 @@ The definitions of both the `s7` protocol and `java` language are provided by th
     <dependency>
       <groupId>org.apache.plc4x.plugins</groupId>
       <artifactId>plc4x-code-generation-language-java</artifactId>
-      <version>{current-last-released-version}</version>
+      <version>{page-component-version}</version>
       <!-- Scope is 'provided' as this way it's not shipped with the driver -->
       <scope>provided</scope>
     </dependency>
@@ -289,7 +289,7 @@ and:
     <dependency>
       <groupId>org.apache.plc4x.plugins</groupId>
       <artifactId>plc4x-code-generation-protocol-s7</artifactId>
-      <version>{current-last-released-version}</version>
+      <version>{page-component-version}</version>
       <!-- Scope is 'provided' as this way it's not shipped with the driver -->
       <scope>provided</scope>
     </dependency>

diff --git a/website/asciidoc/modules/developers/pages/code-gen/language/freemarker.adoc b/website/asciidoc/modules/developers/pages/code-gen/language/freemarker.adoc
@@ -18,7 +18,7 @@
 
 = Apache Freemarker
 
-include::partial$pom.adoc[]
+
 
 For the Freemarker language output we are using an unmodified version of https://freemarker.apache.org[Apache Freemarker] to generate output.
 

diff --git a/website/asciidoc/modules/developers/pages/code-gen/protocol/df1.adoc b/website/asciidoc/modules/developers/pages/code-gen/protocol/df1.adoc
@@ -17,7 +17,7 @@
 
 = Example: DF1 MSpec
 
-include::partial$pom.adoc[]
+
 
 The DF1 protocol has three basic messages: a command message, acknowledge and not acknowledge.
 A `0x10` is used as delimiter to differentiate between the messages and parts of the command message.

diff --git a/website/asciidoc/modules/developers/pages/code-gen/protocol/mspec.adoc b/website/asciidoc/modules/developers/pages/code-gen/protocol/mspec.adoc
@@ -18,7 +18,7 @@
 
 = The MSpec format
 
-include::partial$pom.adoc[]
+
 
 The `MSpec` format (Message Specification) was a result of a brainstorming session after evaluating a lot of other options.
 

diff --git a/website/asciidoc/modules/developers/pages/conferences.adoc b/website/asciidoc/modules/developers/pages/conferences.adoc
@@ -17,7 +17,7 @@
 
 = Conferences & Events
 
-include::partial$pom.adoc[]
+
 
 On this page we are listing options to attend talks and events around PLC4X.
 

diff --git a/website/asciidoc/modules/developers/pages/contributing.adoc b/website/asciidoc/modules/developers/pages/contributing.adoc
@@ -18,8 +18,6 @@
 
 = Contributing
 
-include::partial$pom.adoc[]
-
 == Forms of contribution
 
 There are multiple forms in which you can become involved with the PLC4X project.
@@ -138,7 +136,7 @@ The same model is used for a wide variety of other projects, so it should be pre
 - `release` contains the latest released state.
 - Development is performed on the `develop` branch.
 - Features are developed in Feature-Branches with a prefix `feature/`
-- Each minor release has a corresponding release branch `rel/{current-last-released-version}`
+- Each minor release has a corresponding release branch `rel/{page-component-version}`
 - A release branch is spawned from `develop` only
 - Bugfix releases don't have a dedicated release branch, they are just performed on the corresponding minor versions release branch
 

diff --git a/website/asciidoc/modules/developers/pages/decisions.adoc b/website/asciidoc/modules/developers/pages/decisions.adoc
@@ -18,7 +18,7 @@
 
 = Decision Making
 
-include::partial$pom.adoc[]
+
 
 == Introduction
 

diff --git a/website/asciidoc/modules/developers/pages/index.adoc b/website/asciidoc/modules/developers/pages/index.adoc
@@ -19,7 +19,7 @@
 
 = Developer Section
 
-include::partial$pom.adoc[]
+
 
 This part of the Apache PLC4X dedicated to provide information to people wanting to build PLC4X and hopefully also start contributing to this awesome project.
 

diff --git a/website/asciidoc/modules/developers/pages/infrastructure/ci.adoc b/website/asciidoc/modules/developers/pages/infrastructure/ci.adoc
@@ -18,7 +18,7 @@
 
 = Continuous Integration
 
-include::partial$pom.adoc[]
+
 
 We are currently using the following CI systems.
 

diff --git a/website/asciidoc/modules/developers/pages/infrastructure/index.adoc b/website/asciidoc/modules/developers/pages/infrastructure/index.adoc
@@ -19,6 +19,6 @@
 
 = Infrastructure
 
-include::partial$pom.adoc[]
+
 
 In this section you can find information on the services the Apache PLC4X project makes use of.
diff --git a/website/asciidoc/modules/developers/pages/infrastructure/issues.adoc b/website/asciidoc/modules/developers/pages/infrastructure/issues.adoc
@@ -17,7 +17,7 @@
 
 = Bug & Issue Tracker
 
-include::partial$pom.adoc[]
+
 
 Our bug & issue tracker is Github-Issues.
 

diff --git a/website/asciidoc/modules/developers/pages/infrastructure/sonar.adoc b/website/asciidoc/modules/developers/pages/infrastructure/sonar.adoc
@@ -17,7 +17,7 @@
 
 = Code Analysis
 
-include::partial$pom.adoc[]
+
 
 We are using `SonarCloud` as the service for static code analysis.
 

diff --git a/website/asciidoc/modules/developers/pages/infrastructure/vm.adoc b/website/asciidoc/modules/developers/pages/infrastructure/vm.adoc
@@ -17,7 +17,7 @@
 
 = The PLC4X Project VM
 
-include::partial$pom.adoc[]
+
 
 As, especially for the raw socket functionality of PLC4X, our project had higher demands on the infrastructure as other projects.
 Apache Infra kindly provided us with a dedicated VM.

diff --git a/website/asciidoc/modules/developers/pages/infrastructure/website.adoc b/website/asciidoc/modules/developers/pages/infrastructure/website.adoc
@@ -17,7 +17,7 @@
 
 = Generating the Website
 
-include::partial$pom.adoc[]
+
 
 We are currently using the normal `Maven` build to not only generate the project artifacts, but also the projects website.
 

diff --git a/website/asciidoc/modules/developers/pages/infrastructure/wiki.adoc b/website/asciidoc/modules/developers/pages/infrastructure/wiki.adoc
@@ -17,7 +17,7 @@
 
 = WIKI
 
-include::partial$pom.adoc[]
+
 
 We use Apache's Confluence instance as Wiki, however most information is generally managed on this website.
 

diff --git a/website/asciidoc/modules/developers/pages/jqassistant.adoc b/website/asciidoc/modules/developers/pages/jqassistant.adoc
@@ -18,7 +18,7 @@
 
 = Using JQAssistant
 
-include::partial$pom.adoc[]
+
 
 In PLC4X we are using a tool called `https://jqassistant.org/[JQAssistant]` for enforcing quality assurance rules.
 

diff --git a/website/asciidoc/modules/developers/pages/maturity.adoc b/website/asciidoc/modules/developers/pages/maturity.adoc
@@ -19,7 +19,7 @@
 
 = Apache Maturity Model Assessment for PLC4X
 
-include::partial$pom.adoc[]
+
 
 == Overview
 

diff --git a/website/asciidoc/modules/developers/pages/preparing/index.adoc b/website/asciidoc/modules/developers/pages/preparing/index.adoc
@@ -17,7 +17,7 @@
 
 = Preparing your Computer
 
-include::partial$pom.adoc[]
+
 
 Building a project like Apache PLC4X on multiple target operating-systems is quite a challenge, but I think we managed to make it as simple as possible.
 

diff --git a/website/asciidoc/modules/developers/pages/preparing/linux.adoc b/website/asciidoc/modules/developers/pages/preparing/linux.adoc
@@ -17,7 +17,7 @@
 
 = Linux
 
-include::partial$pom.adoc[]
+
 
 As tracking down issues which result from missing or outdated third party tools such as compilers are always hard do diagnose, we have extended the build of PLC4X with a `prerequisiteCheck` that automatically checks if required tools are installed and if a required minimum version is available.
 

diff --git a/website/asciidoc/modules/developers/pages/preparing/macos.adoc b/website/asciidoc/modules/developers/pages/preparing/macos.adoc
@@ -17,7 +17,7 @@
 
 = Mac OS
 
-include::partial$pom.adoc[]
+
 
 As tracking down issues which result from missing or outdated third party tools such as compilers are always hard do diagnose, we have extended the build of PLC4X with a `prerequisiteCheck` that automatically checks if required tools are installed and if a required minimum version is available.
 

diff --git a/website/asciidoc/modules/developers/pages/preparing/windows.adoc b/website/asciidoc/modules/developers/pages/preparing/windows.adoc
@@ -17,7 +17,7 @@
 
 = Windows
 
-include::partial$pom.adoc[]
+
 
 As tracking down issues which result from missing or outdated third party tools such as compilers are always hard do diagnose, we have extended the build of PLC4X with a `prerequisiteCheck` that automatically checks if required tools are installed and if a required minimum version is available.
 

diff --git a/website/asciidoc/modules/developers/pages/protocols/ads/protocol.adoc b/website/asciidoc/modules/developers/pages/protocols/ads/protocol.adoc
@@ -18,7 +18,7 @@
 = Beckhoff ADS Protocol
 :page-role: home
 
-include::partial$pom.adoc[]
+
 
 // https://plantuml.com/de/activity-diagram-legacy
 // https://deepu.js.org/svg-seq-diagram/Reference_Guide.pdf

diff --git a/website/asciidoc/modules/developers/pages/protocols/eip/protocol.adoc b/website/asciidoc/modules/developers/pages/protocols/eip/protocol.adoc
@@ -18,7 +18,7 @@
 = EIP Protocol
 :page-role: home
 
-include::partial$pom.adoc[]
+
 
 // https://plantuml.com/de/activity-diagram-legacy
 // https://deepu.js.org/svg-seq-diagram/Reference_Guide.pdf

diff --git a/website/asciidoc/modules/developers/pages/protocols/index.adoc b/website/asciidoc/modules/developers/pages/protocols/index.adoc
@@ -17,7 +17,7 @@
 
 = Usage of protocols
 
-include::partial$pom.adoc[]
+
 
 == Currently documented are: