camaraproject / QualityOnDemand

Repository to describe, develop, document and test the QualityOnDemand API family
https://wiki.camaraproject.org/x/zwOeAQ
Apache License 2.0
42 stars 59 forks source link

Clean up of directories according to issue #49 #50

Closed hdamker closed 2 years ago

hdamker commented 2 years ago

Clean up according to #49:

shilpa-padgaonkar commented 2 years ago

For images used in https://github.com/camaraproject/QualityOnDemand/tree/main/documentation/API_documentation/ there is a directory named resources in QoD. In commonalities, the directory is named images https://github.com/camaraproject/WorkingGroups/tree/main/Commonalities/documentation/images

Do we want to follow the same naming convention?

shilpa-padgaonkar commented 2 years ago

May be you want to place the documentation for eg https://github.com/hdamker/QualityOnDemand/blob/clean-up-patch2-%2349/code/API_definitions/Notifications.md and https://github.com/hdamker/QualityOnDemand/blob/clean-up-patch2-%2349/code/API_definitions/QoSProfile_Mapping_Table.md and https://github.com/hdamker/QualityOnDemand/blob/clean-up-patch2-%2349/documentation/QoD-API-Readiness-Checklist.md in the api documentation folder?

shilpa-padgaonkar commented 2 years ago

What about https://github.com/camaraproject/WorkingGroups/issues/63#issuecomment-1259452546 ?

hdamker commented 2 years ago

Do we want to follow the same naming convention?

If all sub projects agree on it, sure. But not covered by the current issue.

hdamker commented 2 years ago

May be you want to place the documentation for eg https://github.com/hdamker/QualityOnDemand/blob/clean-up-patch2-%2349/code/API_definitions/Notifications.md and https://github.com/hdamker/QualityOnDemand/blob/clean-up-patch2-%2349/code/API_definitions/QoSProfile_Mapping_Table.md and https://github.com/hdamker/QualityOnDemand/blob/clean-up-patch2-%2349/documentation/QoD-API-Readiness-Checklist.md in the api documentation folder?

Moved Notifications.md and QoD-API-Readiness-Checklist.md into API_documentation folder. Kept QoSProfile_Mapping_Table.md within its location as it is linked within YAML files and changed in #43.

hdamker commented 2 years ago

What about camaraproject/WorkingGroups#63 (comment) ?

@shilpa-padgaonkar I created a new issue for that #52