{"type":"doc","content":[{"type":"heading","attrs":{"level":2},"content":[{"text":"Level Definitions","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Level 1:","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"User guide created Deployment documentation API documentation Adherence to coding guidelines","parameters":{"reason":"multi-level-list-indentation","nestedContent":{"type":"doc","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"User guide created","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deployment documentation","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API documentation","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Adherence to coding guidelines","type":"text"}]}]}]}]}]}],"version":1},"cxhtml":"

- User guide created
- Deployment documentation
- API documentation
- Adherence to coding guidelines

"}}},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Level 2:","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"API Documentation All new API’s must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines All existing APIs must be documented in Swagger 2.0","parameters":{"reason":"multi-level-list-indentation","nestedContent":{"type":"doc","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API Documentation","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All new API’s must adhere to the ","type":"text"},{"text":"ONAP API Common Versioning Strategy","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16422131"}}]},{"text":" and Documentation Guidelines","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All existing APIs must be documented in Swagger 2.0","type":"text"}]}]}]}]}]}]}]}],"version":1},"cxhtml":"

- API Documentation
  - All new API’s must adhere to the and Documentation Guidelines
  - All existing APIs must be documented in Swagger 2.0

"}}},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Level 3","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"Consistent UI across ONAP projects Usability testing conducted API Documentation All new API’s, all external APIs, and all existing API’s that are modified must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines Level 4","parameters":{"reason":"multi-level-list-indentation","nestedContent":{"type":"doc","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Consistent UI across ONAP projects","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Usability testing conducted","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API Documentation","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All ","type":"text"},{"text":"new","type":"text","marks":[{"type":"em"}]},{"text":" API’s, all ","type":"text"},{"text":"external","type":"text","marks":[{"type":"em"}]},{"text":" APIs, and all existing API’s that are ","type":"text"},{"text":"modified","type":"text","marks":[{"type":"em"}]},{"text":" must adhere to the ","type":"text"},{"text":"ONAP API Common Versioning Strategy","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16422131"}}]},{"text":" and Documentation Guidelines","type":"text"}]}]}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Level 4","type":"text","marks":[{"type":"strong"}]}]}]}]}],"version":1},"cxhtml":"

- Consistent UI across ONAP projects
- Usability testing conducted
- API Documentation
  - All new API’s, all external APIs, and all existing API’s that are modified must adhere to the and Documentation Guidelines
Level 4

"}}},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"API Documentation All API’s for a given project must adhere to the ONAP API Common Versioning Strategy and Documentation Guidelines","parameters":{"reason":"multi-level-list-indentation","nestedContent":{"type":"doc","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"API Documentation","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All API’s for a given project must adhere to the ","type":"text"},{"text":"ONAP API Common Versioning Strategy","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16422131"}}]},{"text":" and Documentation Guidelines","type":"text"}]}]}]}]}]}]}]}],"version":1},"cxhtml":"

- API Documentation
  - All API’s for a given project must adhere to the and Documentation Guidelines

"}}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Minimum Levels (Dublin)","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"All Projects: Level 2","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Stretch Goal: External APIs also follow the Versioning Strategy","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Guidance for Implementation","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"This presentation","type":"text","marks":[{"type":"link","attrs":{"href":"https://wiki.onap.org/display/DW/TSC+2019-01-10?preview=/48529742/48533882/onap_tsc.pdf"}}]},{"text":" gives a good review of what types of documentation should be done and when in the release lifecycle.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Please see the ","type":"text"},{"text":"Documentation team","type":"text","marks":[{"type":"link","attrs":{"href":"https://lf-onap.atlassian.net/wiki/spaces/DW/pages/16230657"}}]},{"text":" for more information.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Contacts","type":"text"}]},{"type":"paragraph","content":[{"text":"Documentation team","type":"text"}]}],"version":1}

Usability (New)

Level Definitions

Minimum Levels (Dublin)

Guidance for Implementation

Contacts