Add XML/JSON/RDF mappings to AsciiDoc Documentation #649
check-title-and-description-of-pull-request.yml
on: pull_request
Check-title-and-description-of-pull-request
21s
Annotations
1 error
Check-title-and-description-of-pull-request
The message 1 is invalid:
* The subject exceeds the limit of 50 characters (got: 51, JSON: "Add XML/JSON/RDF mappings to AsciiDoc Documentation").Please shorten the subject to make it more succinct.
* The line 5 of the message (line 3 of the body) exceeds the limit of 72 characters. The line contains 105 characters: "In this PR we integrated XML/JSON/RDF mapping descriptions in our Antora Documentation based on AsciiDoc:". Please reformat the body so that all the lines fit 72 characters.
* The line 7 of the message (line 5 of the body) exceeds the limit of 72 characters. The line contains 84 characters: "- Transformed README.md contents of XML/JSON/RDF mapping descriptions to .adoc files". Please reformat the body so that all the lines fit 72 characters.
* The line 8 of the message (line 6 of the body) exceeds the limit of 72 characters. The line contains 97 characters: "- Integrated the XML/JSON/RDF Mapping description .adoc files in `mappings.adoc` with `include::`". Please reformat the body so that all the lines fit 72 characters.
* The line 9 of the message (line 7 of the body) exceeds the limit of 72 characters. The line contains 125 characters: "- Adjusted schemas/{XML/JSON/RDF }/README.md contents: added reference to the .adoc files where the mapping will be described". Please reformat the body so that all the lines fit 72 characters.
* The line 15 of the message (line 13 of the body) exceeds the limit of 72 characters. The line contains 98 characters: "- Moved all included parts of `mappings.adoc#Encoding` from folder `includes` to `mappings` folder". Please reformat the body so that all the lines fit 72 characters.
* The line 17 of the message (line 15 of the body) exceeds the limit of 72 characters. The line contains 112 characters: "The example how it looks now: https://rwth-iat.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html". Please reformat the body so that all the lines fit 72 characters.
The original message was:
Add XML/JSON/RDF mappings to AsciiDoc Documentation
closes **https://github.com/admin-shell-io/aas-specs/issues/493**
In this PR we integrated XML/JSON/RDF mapping descriptions in our Antora Documentation based on AsciiDoc:
- Transformed README.md contents of XML/JSON/RDF mapping descriptions to .adoc files
- Integrated the XML/JSON/RDF Mapping description .adoc files in `mappings.adoc` with `include::`
- Adjusted schemas/{XML/JSON/RDF }/README.md contents: added reference to the .adoc files where the mapping will be described
Refactoring:
- Renamed `spec-metamodel/nav-spec.adoc` to `index.adoc`
- Added some tags for referencing
- Create `mappings` folder for `mappings.adoc` and all includes
- Moved all included parts of `mappings.adoc#Encoding` from folder `includes` to `mappings` folder
The example how it looks now: https://rwth-iat.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html
|