Skip to content

Commit

Permalink
chore(website): Fix page links in readme and remove JIRA mentions
Browse files Browse the repository at this point in the history
  • Loading branch information
@hutcheb
hutcheb committed Nov 24, 2024
1 parent 13edf00 commit 0056f68
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 23 deletions.
12 changes: 5 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,15 +83,15 @@ It also provides (Java) tools for usage inside an application:
## Getting started

Depending on the programming language, the usage will differ, therefore please go to the
[Getting Started](https://plc4x.apache.org/users/getting-started/plc4j.html) on the PLC4X website to look up
[Getting Started](https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4j.html) on the PLC4X website to look up
the language of choice.

### Java

NOTE: Currently the Java version which supports building of all parts of Apache PLC4X is at least Java 19 (We have tested all versions up to Java 21), however it's only the Java Tool UI, that requires this right now. All other modules need at least Java 11.

See the PLC4J user guide on the website to start using PLC4X in your Java application:
[https://plc4x.apache.org/users/getting-started/plc4j.html](https://plc4x.apache.org/users/getting-started/plc4j.html)
[https://plc4x.apache.org/plc4x/latest/users/getting-started/plc4j.html](https://plc4x.apache.org/users/getting-started/plc4j.html)

## Developers

Expand All @@ -108,7 +108,7 @@ WARNING: The code generation uses a utility which requires some additional VM se

A more detailed description is available on our website:

https://plc4x.apache.org/developers/preparing/index.html
https://plc4x.apache.org/plc4x/latest/developers/preparing/index.html

#### For building `PLC4C` we also need:

Expand Down Expand Up @@ -221,9 +221,7 @@ Join the PLC4X community by using one of the following channels. We'll be glad t
Subscribe to the following mailing lists:
* Apache PLC4X Developer List: [[email protected]](mailto:[email protected])
* Apache PLC4X Commits List: [[email protected]](mailto:[email protected])
* Apache PLC4X Jira Notification List: [[email protected]](mailto:[email protected])

See also: [https://plc4x.apache.org/mailing-lists.html](https://plc4x.apache.org/mailing-lists.html)
* Apache PLC4X Issue Notification List: [[email protected]](mailto:[email protected])

### Twitter

Expand All @@ -245,7 +243,7 @@ These are, but are not limited to:

We are a very friendly bunch so don’t be afraid to step forward.
If you'd like to contribute to PLC4X, have a look at our
[contribution guide](https://plc4x.apache.org/developers/contributing.html)!
[contribution guide](https://plc4x.apache.org/plc4x/latest/developers/contributing.html)!

## Licensing

Expand Down
10 changes: 1 addition & 9 deletions website/asciidoc/modules/developers/pages/contributing.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -108,18 +108,10 @@ You can do this by executing the following command:

=== Bug Reports

We use https://issues.apache.org/jira/projects/PLC4X[JIRA] as our Bug & Issue Tracker.
We use https://github.com/apache/plc4x/issues[GitHub Issues] as our Bug & Issue Tracker.

Feel free to submit `feature requests`, `bug reports`, `patches`, `comment on issues`, ...

In order to be able to do so, you need to create an account first.

Currently Apache has a separate login system for JIRA and all other services, this might change in the future, but right now it's the way things are.

So if you are considering to contribute more than just a one-time-patch, please choose a username that hasn't been used by an existing http://people.apache.org/committer-index.html[Apache committer] as this will simplify things if we invite you to become part of the team.

If you want to be assigned to an issue because you want to work on it, please request to be added to the JIRA groups on our http://plc4x.apache.org/mailing-lists.html[developers mailing list]

== Documentation

As our documentation and website are generated as a side-product of our build, contributing to this technically the same as contributing to the code.
Expand Down
2 changes: 1 addition & 1 deletion website/asciidoc/modules/developers/pages/maturity.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Community members are encouraged to contribute to this page and comment on it, t
|RE40 |Convenience binaries can be distributed alongside source code but they are not Apache Releases -- they are just a convenience provided with no guarantee. |icon:wrench[role=yellow] Convenience binaries are distributed via Maven Central Repository only. Currently due to the platform-dependency of C++ libraries, these are not distributed currently.
|RE50 |The release process is documented and repeatable to the extent that someone new to the project is able to independently generate the complete set of artifacts required for a release. |icon:check[role=green] We have a guide for release managers, that has been tested by multiple release managers available on our http://plc4x.apache.org/developers/release/release.html[website].
|*Quality* 2+|icon:check[role=green]
|QU10 |The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated. |icon:check[role=green] All issues are documented in our https://issues.apache.org/jira/projects/PLC4X[JIRA] instance, which is our primary bug and issue tracker.
|QU10 |The project is open and honest about the quality of its code. Various levels of quality and maturity for various modules are natural and acceptable as long as they are clearly communicated. |icon:check[role=green] All issues are documented in our https://github.com/apache/plc4x/issues[GitHub Issues] instance, which is our primary bug and issue tracker.
|QU20 |The project puts a very high priority on producing secure software. |icon:check[role=green] even if we haven't received any security issues targeted at PLC4X yet, we proactively monitor our dependencies and if reported would treat them with the highest priority, according to the https://www.apache.org/security/committers.html[CVE/Security Advisory procedure].
|QU30 |The project provides a well-documented, secure and private channel to report security issues, along with a documented way of responding to them. |icon:check[role=green] We are using Apaches default way to submit security related information, which is described on our http://plc4x.apache.org/users/security.html[website]
|QU40 |The project puts a high priority on backwards compatibility and aims to document any incompatible changes and provide tools and documentation to help users transition to new features. |icon:check[role=green] We try to keep everything as backward compatible as possible. If we are forced to introduce incompatible changes, these is documented in a `Incompatible changes` section as part of our release notes.
Expand Down
2 changes: 1 addition & 1 deletion website/asciidoc/modules/developers/pages/release/build-tools.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,6 @@ git merge -X theirs releases/code-generation/{{current-last-released-version}}
Possibly a manual conflict resolution has to be done afterwards. After that, changes need to
be pushed.
In contrast to main releases of PLC4X we won't do any JIRA version updates, updating of the download page or notifying of the world email to [email protected]
In contrast to main releases of PLC4X we won't do any GitHub Issues version updates, updating of the download page or notifying of the world email to [email protected]
So now you're done. Congrats!
4 changes: 2 additions & 2 deletions website/asciidoc/modules/developers/pages/release/release.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ IMPORTANT: Please be sure to execute the release with a Java version 11 or the K
* [ ] Release staging repo on `Nexus`
* [ ] Add the version to the DOAP file on `develop`
* [ ] Update Download site
* [ ] Update Jira
* [ ] Update GitHub Issues
* [ ] Merge back release version to `release` branch
* [ ] Send announce email

Expand Down Expand Up @@ -541,7 +541,7 @@ git merge -X theirs v{current-full-version}
Possibly a manual conflict resolution has to be done afterwards. After that, changes need to
be pushed.
== Updating Jira
== Updating GitHub Issues
1. Set the released version to "released" and set the "release-date"
2. Add the next version to the versions.
Expand Down
6 changes: 3 additions & 3 deletions website/resources/plc4x-doap.rdf
View file
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@
<asfext:pmc rdf:resource="https://plc4x.apache.org/"/>
<shortdesc>Universal API for communicating with programmable logic controllers.</shortdesc>
<description>PLC4X is a set of libraries for communicating with industrial programmable logic controllers (PLCs) using a variety of protocols but with a shared API.</description>
<bug-database rdf:resource="https://issues.apache.org/jira/projects/PLC4X"/>
<download-page rdf:resource="https://plc4x.apache.org/users/download.html"/>
<mailing-list rdf:resource="https://plc4x.apache.org/mailing-lists.html"/>
<bug-database rdf:resource="https://github.com/apache/plc4x/issues"/>
<download-page rdf:resource="https://plc4x.apache.org/plc4x/latest/users/download.html"/>
<mailing-list rdf:resource="https://plc4x.apache.org/plc4x/latest/mailing-lists.html"/>

<programming-language>C</programming-language>
<programming-language>C++</programming-language>
Expand Down

0 comments on commit 0056f68

Please sign in to comment.