TI API Rel 0.9.4 new Documentation #241
Conversation
- new Release Notes section added in Documentation, to replace the .md documentation file - Minor changes: - modified camara URL to refer to the Edge Cloud WG - OAS version now includes "-wip" extension - simplified "Servers" section and included "vwip" as version
TI API Rel 0.9.4 new Documentation
FabrizioMoggio
requested review from
gunjald,
Kevsy,
crissancas,
nicolacdnll,
gainsley and
javierlozallu
as code owners
|
MegaLinter is passed. |
|
In the Edge Cloud call (21/05) we decided to mode the .md file in: https://github.com/camaraproject/EdgeCloud/tree/main/documentation/SupportingDocuments Currently the .md files are in: @javierlozallu isn't it better to leave the .md file there adding a note in the readme.md file and maybe modifying the name of the documentation file as: "Traffic_Influence_API_Documentation_Obsolete.md" |
Yes, didn't remember that .md doc is actually on Supporting Documents so we can keep it there and add the Obsolete sufix. Now I have a doubt @Kevsy @FabrizioMoggio, this folder https://github.com/camaraproject/EdgeCloud/tree/main/documentation/API_documentation should be the one that contains all the official information about the APIs (User Story, Checklist, Documentation_Obsolete*, etc)?? If is the case we can create a subfolder for each API to avoid mixing APIs documentation. |
as discussed here: camaraproject#241 (comment) Also adding a note on top of the file
|
Still a MegaLinter error due to: code/API_definitions/EdgeCloud_LcM.yaml |
|
is there any objection to merge this PR? |
What type of PR is this?
correction
cleanup
documentation
What this PR does / why we need it:
This PR incorporates the whole documentation in the YAML file deleting the Documentation .md file as described:
#229
There is also some minor changes on the YAML code to be aligned with the CAMARA Guidelines and Release Management