Skip to content

Commit f2372e1

Browse files
hutchebhutcheb
committed
fix(website): Fixed Edit Button, Page Attributes and Apache Links
1 parent a3266ed commit f2372e1

File tree

131 files changed

+238
-377
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

131 files changed

+238
-377
lines changed

‎plc4j/drivers/all/src/site/groovy/generate-config-documentation.groovy

+1-1
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ for (final def protocolCode in plcDriverManager.getProtocolCodes()) {
102102
"<dependency>\n" +
103103
" <groupId>org.apache.plc4x</groupId>\n" +
104104
" <artifactId>" + moduleName + "</artifactId>\n" +
105-
" <version>{current-last-released-version}</version>\n" +
105+
" <version>{page-component-version}</version>\n" +
106106
"</dependency>\n" +
107107
"----"
108108
if(driver.metadata.defaultTransportCode.isPresent()) {

‎website/antora-playbook.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ content:
2222
sources:
2323
- url: ../..
2424
branches: HEAD
25-
start_path: website/target/asciidoc
25+
start_path: website/asciidoc
2626
ui:
2727
bundle:
2828
url: https://gitlab.com/antora/antora-ui-default/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable

‎website/asciidoc/antora.yml

+1-2
Original file line numberDiff line numberDiff line change
@@ -17,11 +17,10 @@
1717
# under the License.
1818
#
1919
name: plc4x
20-
version: 'latest'
20+
version: '0.13.0-SNAPSHOT'
2121
prerelease: True
2222
title: PLC4X
2323
nav:
2424
- modules/ROOT/nav.adoc
2525
- modules/users/nav.adoc
2626
- modules/developers/nav.adoc
27-
- modules/apache/nav.adoc

‎website/asciidoc/modules/apache/nav.adoc

-23
This file was deleted.

‎website/asciidoc/modules/apache/pages/index.adoc

-20
This file was deleted.

‎website/asciidoc/modules/developers/pages/architecture.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
== Simple case
2121

22-
include::partial$pom.adoc[]
22+
2323

2424
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.
2525
A MessageCodec uses a TransportInstance to communicate with the target device.

‎website/asciidoc/modules/developers/pages/building.adoc

+3-5
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@
1717

1818
= Building PLC4X
1919

20-
include::partial$pom.adoc[]
21-
2220
PLC4X is built with `Apache Maven` and we have tried to make the build as simple as possible.
2321

2422
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 {
158156
}
159157
160158
dependencies {
161-
implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{current-last-released-version}'
162-
implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{current-last-released-version}'
163-
implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{current-last-released-version}'
159+
implementation group: 'org.apache.plc4x', name: 'plc4j-api', version: '{page-component-version}'
160+
implementation group: 'org.apache.plc4x', name: 'plc4j-driver-s7', version: '{page-component-version}'
161+
implementation group: 'org.apache.plc4x', name: 'plc4j-connection-pool', version: '{page-component-version}'
164162
}
165163
----

‎website/asciidoc/modules/developers/pages/code-gen/index.adoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
= Code Generation
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
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.
2424

@@ -199,7 +199,7 @@ Here's an example of a driver pom for building a `S7` driver for `java`:
199199
<parent>
200200
<groupId>org.apache.plc4x.plugins</groupId>
201201
<artifactId>plc4x-code-generation</artifactId>
202-
<version>{current-last-released-version}</version>
202+
<version>{page-component-version}</version>
203203
</parent>
204204
205205
<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`:
231231
<dependency>
232232
<groupId>org.apache.plc4x.plugins</groupId>
233233
<artifactId>plc4x-code-generation-driver-base-java</artifactId>
234-
<version>{current-last-released-version}</version>
234+
<version>{page-component-version}</version>
235235
</dependency>
236236
237237
<dependency>
238238
<groupId>org.apache.plc4x.plugins</groupId>
239239
<artifactId>plc4x-code-generation-language-java</artifactId>
240-
<version>{current-last-released-version}</version>
240+
<version>{page-component-version}</version>
241241
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
242242
<scope>provided</scope>
243243
</dependency>
244244
245245
<dependency>
246246
<groupId>org.apache.plc4x.plugins</groupId>
247247
<artifactId>plc4x-code-generation-protocol-s7</artifactId>
248-
<version>{current-last-released-version}</version>
248+
<version>{page-component-version}</version>
249249
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
250250
<scope>provided</scope>
251251
</dependency>
@@ -263,7 +263,7 @@ The dependency:
263263
<dependency>
264264
<groupId>org.apache.plc4x.plugins</groupId>
265265
<artifactId>plc4x-code-generation-driver-base-java</artifactId>
266-
<version>{current-last-released-version}</version>
266+
<version>{page-component-version}</version>
267267
</dependency>
268268
....
269269

@@ -276,7 +276,7 @@ The definitions of both the `s7` protocol and `java` language are provided by th
276276
<dependency>
277277
<groupId>org.apache.plc4x.plugins</groupId>
278278
<artifactId>plc4x-code-generation-language-java</artifactId>
279-
<version>{current-last-released-version}</version>
279+
<version>{page-component-version}</version>
280280
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
281281
<scope>provided</scope>
282282
</dependency>
@@ -289,7 +289,7 @@ and:
289289
<dependency>
290290
<groupId>org.apache.plc4x.plugins</groupId>
291291
<artifactId>plc4x-code-generation-protocol-s7</artifactId>
292-
<version>{current-last-released-version}</version>
292+
<version>{page-component-version}</version>
293293
<!-- Scope is 'provided' as this way it's not shipped with the driver -->
294294
<scope>provided</scope>
295295
</dependency>

‎website/asciidoc/modules/developers/pages/code-gen/language/freemarker.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
= Apache Freemarker
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
For the Freemarker language output we are using an unmodified version of https://freemarker.apache.org[Apache Freemarker] to generate output.
2424

‎website/asciidoc/modules/developers/pages/code-gen/protocol/df1.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Example: DF1 MSpec
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
The DF1 protocol has three basic messages: a command message, acknowledge and not acknowledge.
2323
A `0x10` is used as delimiter to differentiate between the messages and parts of the command message.

‎website/asciidoc/modules/developers/pages/code-gen/protocol/mspec.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
= The MSpec format
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
The `MSpec` format (Message Specification) was a result of a brainstorming session after evaluating a lot of other options.
2424

‎website/asciidoc/modules/developers/pages/conferences.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Conferences & Events
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
On this page we are listing options to attend talks and events around PLC4X.
2323

‎website/asciidoc/modules/developers/pages/contributing.adoc

+1-3
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@
1818

1919
= Contributing
2020

21-
include::partial$pom.adoc[]
22-
2321
== Forms of contribution
2422

2523
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
138136
- `release` contains the latest released state.
139137
- Development is performed on the `develop` branch.
140138
- Features are developed in Feature-Branches with a prefix `feature/`
141-
- Each minor release has a corresponding release branch `rel/{current-last-released-version}`
139+
- Each minor release has a corresponding release branch `rel/{page-component-version}`
142140
- A release branch is spawned from `develop` only
143141
- Bugfix releases don't have a dedicated release branch, they are just performed on the corresponding minor versions release branch
144142

‎website/asciidoc/modules/developers/pages/decisions.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
= Decision Making
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
== Introduction
2424

‎website/asciidoc/modules/developers/pages/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
= Developer Section
2121

22-
include::partial$pom.adoc[]
22+
2323

2424
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.
2525

‎website/asciidoc/modules/developers/pages/infrastructure/ci.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
= Continuous Integration
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
We are currently using the following CI systems.
2424

‎website/asciidoc/modules/developers/pages/infrastructure/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,6 @@
1919

2020
= Infrastructure
2121

22-
include::partial$pom.adoc[]
22+
2323

2424
In this section you can find information on the services the Apache PLC4X project makes use of.

‎website/asciidoc/modules/developers/pages/infrastructure/issues.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Bug & Issue Tracker
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
Our bug & issue tracker is Github-Issues.
2323

‎website/asciidoc/modules/developers/pages/infrastructure/sonar.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Code Analysis
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
We are using `SonarCloud` as the service for static code analysis.
2323

‎website/asciidoc/modules/developers/pages/infrastructure/vm.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= The PLC4X Project VM
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
As, especially for the raw socket functionality of PLC4X, our project had higher demands on the infrastructure as other projects.
2323
Apache Infra kindly provided us with a dedicated VM.

‎website/asciidoc/modules/developers/pages/infrastructure/website.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Generating the Website
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
We are currently using the normal `Maven` build to not only generate the project artifacts, but also the projects website.
2323

‎website/asciidoc/modules/developers/pages/infrastructure/wiki.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= WIKI
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
We use Apache's Confluence instance as Wiki, however most information is generally managed on this website.
2323

‎website/asciidoc/modules/developers/pages/jqassistant.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
= Using JQAssistant
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
In PLC4X we are using a tool called `https://jqassistant.org/[JQAssistant]` for enforcing quality assurance rules.
2424

‎website/asciidoc/modules/developers/pages/maturity.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
= Apache Maturity Model Assessment for PLC4X
2121

22-
include::partial$pom.adoc[]
22+
2323

2424
== Overview
2525

‎website/asciidoc/modules/developers/pages/preparing/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Preparing your Computer
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
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.
2323

‎website/asciidoc/modules/developers/pages/preparing/linux.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Linux
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
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.
2323

‎website/asciidoc/modules/developers/pages/preparing/macos.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Mac OS
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
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.
2323

‎website/asciidoc/modules/developers/pages/preparing/windows.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Windows
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
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.
2323

‎website/asciidoc/modules/developers/pages/protocols/ads/protocol.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
= Beckhoff ADS Protocol
1919
:page-role: home
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
// https://plantuml.com/de/activity-diagram-legacy
2424
// https://deepu.js.org/svg-seq-diagram/Reference_Guide.pdf

‎website/asciidoc/modules/developers/pages/protocols/eip/protocol.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
= EIP Protocol
1919
:page-role: home
2020

21-
include::partial$pom.adoc[]
21+
2222

2323
// https://plantuml.com/de/activity-diagram-legacy
2424
// https://deepu.js.org/svg-seq-diagram/Reference_Guide.pdf

‎website/asciidoc/modules/developers/pages/protocols/index.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
= Usage of protocols
1919

20-
include::partial$pom.adoc[]
20+
2121

2222
== Currently documented are:
2323

0 commit comments

Comments
 (0)