Fix description error in doc: majorVersion in MQTT topic should be v2 for version 2.0 of the VDA5050 specification

thkfighter commented 7 months ago

Description

In the doc files,

a minor error: majorVersion in an MQTT topic, interfaceName/majorVersion/manufacturer/serialNumber/topic, should be v2 for version 2.0 of the VDA5050 specification. ~~- a grammatical mistake: an MQTT topic is published or subscribed to, not "published to".~~

Checklist

[x] You have the right to contribute the code/documentation/assets to this project, and you agree to contribute it under the terms of the project's license(s).
[x] All changes have been made on a separate branch (not master) in a fork.
[x] The whole project compiles correctly and all tests pass, i.e. gradlew clean build succeeds with the changes made, and without unavoidable compiler/toolchain warnings.
[ ] New tests covering the change have been added, if it is possible / makes sense.
[x] The documentation has been extended, if necessary.
[x] The PR contains a proposal for a well-formed commit message that mentions all authors who contributed to the PR. (The commits in the PR will be squashed into one commit on the base branch, and your proposed message is intended to be used for this commit. See below for a template you can use for the message. See this blog post and this one for more on well-formed commit messages.)

Proposed squash commit message

Correct majorVersion in MQTT topics in doc

In the doc files,
* majorVersion in an MQTT topic, interfaceName/majorVersion/
  manufacturer/serialNumber/topic, should be v2 for version 2.0 
  of the VDA5050 specification.

* An MQTT topic is published or subscribed to, not "published to".

swltr commented 7 months ago

@thkfighter Thank you for your contribution! Please note that the pull request description template provided in this project is mandatory. Can you please apply it to your PR description before we merge the PR?

sonarcloud[bot] commented 7 months ago

Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

swltr commented 6 months ago

@thkfighter The topic names used for 2.0 are definitely wrong - thank you for the fix! One thing I didn't noticed when first reading your PR, though: I'd argue that while messages are "published" or "published to a topic", topics are indeed "published to".

swltr commented 5 months ago

@thkfighter You reacted with 👍 to my previous comment. Can you change the wording back to "published to", then?

sonarcloud[bot] commented 5 months ago

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud

thkfighter commented 5 months ago

@thkfighter You reacted with 👍 to my previous comment. Can you change the wording back to "published to", then?

Done.

swltr commented 5 months ago

Merged - thanks for the fix!

openTCS / opentcs-commadapter-vda5050