You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@plc4x.apache.org by cd...@apache.org on 2020/02/12 22:08:34 UTC
[plc4x] branch develop updated: - Structural updates - Fixed
incorrect information
This is an automated email from the ASF dual-hosted git repository.
cdutz pushed a commit to branch develop
in repository https://gitbox.apache.org/repos/asf/plc4x.git
The following commit(s) were added to refs/heads/develop by this push:
new 160d409 - Structural updates - Fixed incorrect information
160d409 is described below
commit 160d4097dde1f3545fa95a6845ed834da6192229
Author: Christofer Dutz <ch...@c-ware.de>
AuthorDate: Wed Feb 12 23:08:07 2020 +0100
- Structural updates
- Fixed incorrect information
---
src/site/asciidoc/developers/index.adoc | 18 ++++++++++--------
.../asciidoc/developers/infrastructure/index.adoc | 4 +++-
.../asciidoc/developers/infrastructure/issues.adoc | 4 ++++
.../asciidoc/developers/infrastructure/sonar.adoc | 6 +++++-
src/site/asciidoc/developers/infrastructure/vm.adoc | 5 +++--
.../asciidoc/developers/infrastructure/vpn.adoc | 20 ++++++++++----------
.../asciidoc/developers/infrastructure/wiki.adoc | 4 ++++
src/site/asciidoc/developers/preparing.adoc | 4 +++-
src/site/asciidoc/developers/release/index.adoc | 2 +-
.../{infrastructure => tutorials}/index.adoc | 2 +-
.../writing-driver.adoc | 2 +-
.../{ => plcs}/plc4x-vpn-beckhoff-route-1.png | Bin
.../{ => plcs}/plc4x-vpn-beckhoff-route-2.png | Bin
.../{ => plcs}/plc4x-vpn-beckhoff-route-3.png | Bin
.../images/{ => plcs}/plc4x-vpn-beckhoff.jpg | Bin
.../images/{ => plcs}/plc4x-vpn-client-download.png | Bin
.../resources/images/{ => plcs}/plc4x-vpn-fatek.jpg | Bin
.../images/{ => plcs}/plc4x-vpn-siemens-hmi.jpg | Bin
.../images/{ => plcs}/plc4x-vpn-siemens-s7.jpg | Bin
.../resources/images/{ => plcs}/plc4x-vpn-wago.jpg | Bin
src/site/site.xml | 3 +++
21 files changed, 48 insertions(+), 26 deletions(-)
diff --git a/src/site/asciidoc/developers/index.adoc b/src/site/asciidoc/developers/index.adoc
index 5cd3b52..0938193 100644
--- a/src/site/asciidoc/developers/index.adoc
+++ b/src/site/asciidoc/developers/index.adoc
@@ -21,14 +21,6 @@
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.
-=== Getting Help
-
-The primary source for getting help definitely is our project mailing list dev@plc4x.apache.org.
-
-You can search previous content in our link:++https://lists.apache.org/list.html?dev@plc4x.apache.org++[Mail Archive]
-
-In order to post to the list you first need to subscribe. This can be done by sending an empty Email to dev-subscribe@plc4x.apache.org.
-
=== Getting Started
We have tried to make the PLC4X build experience as smooth as possible and have tried to reduce the number of required third party tools to an absolute minimum.
@@ -49,7 +41,17 @@ We have a dedicated page on link:bulding.html[Building PLC4X].
Please read this page on information about how to build Apache PLC4X.
+=== Contributing
+If you want to work on Apache PLC4X in order to `fix thing`, `add things` and start contributing back to the project, please have a look at our link:contributng.html[Contributing] page. It should contain all the information you need.
+
+=== Getting Help
+
+The primary source for getting help definitely is our project mailing list dev@plc4x.apache.org.
+
+You can search previous content in our link:++https://lists.apache.org/list.html?dev@plc4x.apache.org++[Mail Archive]
+
+In order to post to the list you first need to subscribe. This can be done by sending an empty Email to dev-subscribe@plc4x.apache.org.
diff --git a/src/site/asciidoc/developers/infrastructure/index.adoc b/src/site/asciidoc/developers/infrastructure/index.adoc
index 016d248..5e5a900 100644
--- a/src/site/asciidoc/developers/infrastructure/index.adoc
+++ b/src/site/asciidoc/developers/infrastructure/index.adoc
@@ -17,4 +17,6 @@
:imagesdir: ../../images/
:icons: font
-== Integrations
+== Infrastructure
+
+In this section you can find information on the services the Apache PLC4X project makes use of.
diff --git a/src/site/asciidoc/developers/infrastructure/issues.adoc b/src/site/asciidoc/developers/infrastructure/issues.adoc
index f813330..ccb5c20 100644
--- a/src/site/asciidoc/developers/infrastructure/issues.adoc
+++ b/src/site/asciidoc/developers/infrastructure/issues.adoc
@@ -17,4 +17,8 @@
== Bug & Issue Tracker
+Our bug & issue tracker is Apache's Jira instance.
+
+This service is available here:
+
https://issues.apache.org/jira/projects/PLC4X
\ No newline at end of file
diff --git a/src/site/asciidoc/developers/infrastructure/sonar.adoc b/src/site/asciidoc/developers/infrastructure/sonar.adoc
index a84eed4..8429dee 100644
--- a/src/site/asciidoc/developers/infrastructure/sonar.adoc
+++ b/src/site/asciidoc/developers/infrastructure/sonar.adoc
@@ -17,4 +17,8 @@
== Code Analysis
-https://builds.apache.org/analysis/overview?id=55410
\ No newline at end of file
+We are using `SonarCloud` as the service for static code analysis.
+
+This is an externally hosted service and is available here:
+
+https://sonarcloud.io/dashboard?id=apache_plc4x
\ No newline at end of file
diff --git a/src/site/asciidoc/developers/infrastructure/vm.adoc b/src/site/asciidoc/developers/infrastructure/vm.adoc
index 095bcc0..dce9788 100644
--- a/src/site/asciidoc/developers/infrastructure/vm.adoc
+++ b/src/site/asciidoc/developers/infrastructure/vm.adoc
@@ -74,8 +74,6 @@ Instead of now entering a password, a challenge is displayed:
If you now enter your normal password, you'll simply get `permission denied` errors.
In order to execute operations as root on the machine, you need to use an opie client.
-As with the latest version of Mac Catalina the existing clients no longer work and using a public web service is a really bad idea, Apache has a service to calculate:
-https://reference.apache.org/pdf.lua?/committer/opie
otp-md5 496 pl8230
@@ -87,6 +85,9 @@ When hitting enter or clicking on `Compute` the tool should automatically genera
Now all you need to do is copy & paste that as password into your SSH client session.
+TIP: As with the latest version of Mac Catalina the existing clients no longer work and using a public web service is a really bad idea, Apache has a service to calculate:
+https://selfserve.apache.org/otp-md5.html
+
=== Required software
For being able to build the charts and graphics as part of the site generation, we need to add some additional packages:
diff --git a/src/site/asciidoc/developers/infrastructure/vpn.adoc b/src/site/asciidoc/developers/infrastructure/vpn.adoc
index ba7f08e..33c43fa 100644
--- a/src/site/asciidoc/developers/infrastructure/vpn.adoc
+++ b/src/site/asciidoc/developers/infrastructure/vpn.adoc
@@ -14,7 +14,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.
//
-:imagesdir: ../images/
+:imagesdir: ../../images/
== The PLC4X PLC VPN
@@ -64,7 +64,7 @@ The following PLCs have been configured and should be available in the VPN.
==== Fatek: FBs-40MC
-image::plc4x-vpn-fatek.jpg[float=right, width=200]
+image::plcs/plc4x-vpn-fatek.jpg[float=right, width=200]
This device is able to use the following protocols:
@@ -75,7 +75,7 @@ It is configured to use the IP: `10.10.64.10`
==== Siemens: S7-1212AC/DC
-image::plc4x-vpn-siemens-s7.jpg[float=right, width=200]
+image::plcs/plc4x-vpn-siemens-s7.jpg[float=right, width=200]
This device is able to use the following protocols:
@@ -87,7 +87,7 @@ It is configured to use the IP: `10.10.64.20`
==== Siemens: KTP 400 Basic Mono
-image::plc4x-vpn-siemens-hmi.jpg[float=right, width=200]
+image::plcs/plc4x-vpn-siemens-hmi.jpg[float=right, width=200]
This device is able to use the following protocols:
@@ -99,7 +99,7 @@ It is configured to use the IP: `10.10.64.25`
==== WaGo: 750-352 Feldbuskoppler ETHERNET
-image::plc4x-vpn-wago.jpg[float=right, width=200]
+image::plcs/plc4x-vpn-wago.jpg[float=right, width=200]
This device is not a typical PLC, but more a device making I/O values available via Ethernet protocols.
@@ -116,7 +116,7 @@ The login for this is user: 'admin' pass: 'wago'.
==== Beckhoff: C6920-0030
-image::plc4x-vpn-beckhoff.jpg[float=right, width=200]
+image::plcs/plc4x-vpn-beckhoff.jpg[float=right, width=200]
This device is able to use the following protocols:
@@ -138,15 +138,15 @@ Right now we hope that as soon as routes have been added for quite some ips, eve
Adding a route is done by opening the ADS Route Editor on the Beckhoff machine:
-image::plc4x-vpn-beckhoff-route-1.png[]
+image::plcs/plc4x-vpn-beckhoff-route-1.png[]
Here you click on add:
-image::plc4x-vpn-beckhoff-route-2.png[]
+image::plcs/plc4x-vpn-beckhoff-route-2.png[]
And enter the details of the new route:
-image::plc4x-vpn-beckhoff-route-3.png[]
+image::plcs/plc4x-vpn-beckhoff-route-3.png[]
Here it is important to give the route a name.
The `AmsNetId` is sort of like a 6-segment ipv4-address. It could be chosen independently from the real ip address, however the default is to use the ip address for the first 4 segments and to append `.1.1` after this.
@@ -178,7 +178,7 @@ By accessing the following URL with the `username` and `password`, provided by `
https://vpn.plc4x.apache.org:444
-image::plc4x-vpn-client-download.png[float=right]
+image::plcs/plc4x-vpn-client-download.png[float=right]
However it is also possible to use other VPN clients based on `OpenVPN`.
diff --git a/src/site/asciidoc/developers/infrastructure/wiki.adoc b/src/site/asciidoc/developers/infrastructure/wiki.adoc
index 3e6d859..fd570c2 100644
--- a/src/site/asciidoc/developers/infrastructure/wiki.adoc
+++ b/src/site/asciidoc/developers/infrastructure/wiki.adoc
@@ -17,4 +17,8 @@
== WIKI
+We use Apache's Confluence instance as Wiki, however most information is generally managed on this website.
+
+This service is available here:
+
https://cwiki.apache.org/confluence/display/PLC4X
\ No newline at end of file
diff --git a/src/site/asciidoc/developers/preparing.adoc b/src/site/asciidoc/developers/preparing.adoc
index 7ab93c9..414cbf8 100644
--- a/src/site/asciidoc/developers/preparing.adoc
+++ b/src/site/asciidoc/developers/preparing.adoc
@@ -43,6 +43,8 @@ However in the past with Oracle's new release strategy, there have been a few bu
* bison
* flex
* python
+| `with-docker ` | Adds building of Docker images a|
+* docker
|===
The following chapters will describe how to provide these requirements sorted by operating system.
@@ -182,7 +184,7 @@ Yum based systems:
sudo yum install flex
-=== macOS
+=== MacOS
Most libraries on Mac are installed using `Homebrew`.
diff --git a/src/site/asciidoc/developers/release/index.adoc b/src/site/asciidoc/developers/release/index.adoc
index 016d248..1ac78f0 100644
--- a/src/site/asciidoc/developers/release/index.adoc
+++ b/src/site/asciidoc/developers/release/index.adoc
@@ -17,4 +17,4 @@
:imagesdir: ../../images/
:icons: font
-== Integrations
+== Releasing and Validating Releases
diff --git a/src/site/asciidoc/developers/infrastructure/index.adoc b/src/site/asciidoc/developers/tutorials/index.adoc
similarity index 98%
copy from src/site/asciidoc/developers/infrastructure/index.adoc
copy to src/site/asciidoc/developers/tutorials/index.adoc
index 016d248..6d18da0 100644
--- a/src/site/asciidoc/developers/infrastructure/index.adoc
+++ b/src/site/asciidoc/developers/tutorials/index.adoc
@@ -17,4 +17,4 @@
:imagesdir: ../../images/
:icons: font
-== Integrations
+== Tutorials
diff --git a/src/site/asciidoc/developers/writing-driver/writing-driver.adoc b/src/site/asciidoc/developers/tutorials/writing-driver.adoc
similarity index 97%
rename from src/site/asciidoc/developers/writing-driver/writing-driver.adoc
rename to src/site/asciidoc/developers/tutorials/writing-driver.adoc
index f071fac..fceff14 100644
--- a/src/site/asciidoc/developers/writing-driver/writing-driver.adoc
+++ b/src/site/asciidoc/developers/tutorials/writing-driver.adoc
@@ -29,7 +29,7 @@ The general pipeline for a Protocol looks like the following:
:
v
+-------------------------------------+
-| PLC4X Optimizier :
+| PLC4X Optimizer :
| Possibly collapse requests |
+-------------------------------------+
|
diff --git a/src/site/resources/images/plc4x-vpn-beckhoff-route-1.png b/src/site/resources/images/plcs/plc4x-vpn-beckhoff-route-1.png
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-beckhoff-route-1.png
rename to src/site/resources/images/plcs/plc4x-vpn-beckhoff-route-1.png
diff --git a/src/site/resources/images/plc4x-vpn-beckhoff-route-2.png b/src/site/resources/images/plcs/plc4x-vpn-beckhoff-route-2.png
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-beckhoff-route-2.png
rename to src/site/resources/images/plcs/plc4x-vpn-beckhoff-route-2.png
diff --git a/src/site/resources/images/plc4x-vpn-beckhoff-route-3.png b/src/site/resources/images/plcs/plc4x-vpn-beckhoff-route-3.png
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-beckhoff-route-3.png
rename to src/site/resources/images/plcs/plc4x-vpn-beckhoff-route-3.png
diff --git a/src/site/resources/images/plc4x-vpn-beckhoff.jpg b/src/site/resources/images/plcs/plc4x-vpn-beckhoff.jpg
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-beckhoff.jpg
rename to src/site/resources/images/plcs/plc4x-vpn-beckhoff.jpg
diff --git a/src/site/resources/images/plc4x-vpn-client-download.png b/src/site/resources/images/plcs/plc4x-vpn-client-download.png
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-client-download.png
rename to src/site/resources/images/plcs/plc4x-vpn-client-download.png
diff --git a/src/site/resources/images/plc4x-vpn-fatek.jpg b/src/site/resources/images/plcs/plc4x-vpn-fatek.jpg
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-fatek.jpg
rename to src/site/resources/images/plcs/plc4x-vpn-fatek.jpg
diff --git a/src/site/resources/images/plc4x-vpn-siemens-hmi.jpg b/src/site/resources/images/plcs/plc4x-vpn-siemens-hmi.jpg
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-siemens-hmi.jpg
rename to src/site/resources/images/plcs/plc4x-vpn-siemens-hmi.jpg
diff --git a/src/site/resources/images/plc4x-vpn-siemens-s7.jpg b/src/site/resources/images/plcs/plc4x-vpn-siemens-s7.jpg
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-siemens-s7.jpg
rename to src/site/resources/images/plcs/plc4x-vpn-siemens-s7.jpg
diff --git a/src/site/resources/images/plc4x-vpn-wago.jpg b/src/site/resources/images/plcs/plc4x-vpn-wago.jpg
similarity index 100%
rename from src/site/resources/images/plc4x-vpn-wago.jpg
rename to src/site/resources/images/plcs/plc4x-vpn-wago.jpg
diff --git a/src/site/site.xml b/src/site/site.xml
index dd708c4..e3ef16d 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -90,6 +90,9 @@
<item name="Preparing your Computer" href="developers/preparing.html"/>
<item name="Building" href="developers/building.html"/>
<item name="Contributing" href="developers/contributing.html"/>
+ <item name="Tutorials" href="developers/tutorials/index.html">
+ <item name="Writing Drivers" href="developers/tutorials/writing-driver.html"/>
+ </item>
<item name="Code Generation" href="developers/code-gen/index.html">
<item name="Protocol: MSpec Format" href="developers/code-gen/protocol/mspec.html"/>
<item name="Language: Apache Freemarker" href="developers/code-gen/language/freemarker.html"/>