Skip to content
Snippets Groups Projects
Commit eea927c2 authored by Miguel Angel Reina Ortega's avatar Miguel Angel Reina Ortega
Browse files

Update of README.md file

parent 31285a03
No related tags found
No related merge requests found
Pipeline #1190 skipped
# oneM2M ts-0041 Specification
# oneM2M TS-0041 Specification
This repository hosts the oneM2M ts-0041 specification defined by oneM2M Partnership project.
This repository hosts the oneM2M TS-0041 specification defined by oneM2M Partnership project.
Please, contact the rapporteur, RAPPORTEUR_NAME (RAPPORTEUR_EMAIL), if you need any help with this specification/repository.
## Available versions
All available baselines produced from this repository are available at [ts-0041-baselines](https://specifications.onem2m.org/ts-0041/) (**URL available only if there is at least one baseline**)
All available baselines produced from this repository are available at [TS-0041 Website](https://specifications.onem2m.org/TS-0041/) (**URL available only if there is at least one baseline**)
Different downloadable formats are available under Download tab
## How to raise issues
Please report errors, bugs or other issues [here](https://git.onem2m.org/specifications/ts-0041/issues) or [here](https://git.onem2m.org/issues/issues).
Please report errors, bugs or other issues [here](https://git.onem2m.org/specifications/TS-0041/issues) or [here](https://git.onem2m.org/issues/issues).
## How to contribute
......@@ -20,12 +23,17 @@ For more information, visit the [oneM2M Gitlab contribution procedure](https://g
A set of tools is used by this repository to facilitate the contribution management:
- Autogeneration of Word CR documents:
- Upon creation of a Merge Request, a pipeline is executed to produce the associated Word CR document that contains the tracked changes proposed by the Merge Request.
- Right after creation of a Merge Request, the source branch is protected in order to avoid any further change to the submitted contribution
- Upon creation of a Merge Request, a pipeline is executed to produce the associated Word CR documents:
- Main document contains the git diff proposed by the Merge Request.
- Second document contains the tracked changes proposed by the Merge Request. Note that this is for information and it won't be generated anymore in the near future.
- Right after creation of a Merge Request, the source branch needs to be protected in order to avoid any further change to the submitted contribution.
Automated branch protection is disabled for the time being.
**EXTREMELY IMPORTANT TO CHECK THAT SUBMITTED CONTRIBUTION AND MERGE REQUEST CORRESPOND TO THE SAME LAST COMMIT ID**
- Publication of a new baseline
- Upon creation of tag, a Word document will be generated from the markdown specification in this repository and published at the [ts-0041 specifications](https://specifications.onem2m.org/ts-0041/)
- As Table of Content is not used in the markdown specfication document of this repository. A tool will generate the ToC and add it to the any new published baseline.
- Upon creation of tag, a new version of the spec will be added to the TS-0041 Website and corresponding downloadable documents will also be generated from the markdown specification in this repository
- As Table of Content is not used in the markdown specfication document of this repository, a tool will generate the ToC and add it to the any new published baseline.
Please, refer to [Tools/Scripts repository](hhtps://git.onem2m.org/tools/scripts) for more details.
......@@ -36,3 +44,7 @@ Some known issues:
- Additions/deletions of a list of elements will make the list appearing as not enumerated in the Word CR
- Changes in the first row of a table will break the conversion of such table to Word, the markdown table source code will be seen
- Changes in clause titles will break the conversion of corresponding headings to Word, the markdown heading code will be seen
- Protection of the contribution branch
- It needs to be done manually (for the time being) by the Rapporteur of the TS-0041 specification
- If a revision is needed for the contribution, contribution branch needs to be unprotected by the Rapporteur
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment