2021-11-25 Doc project meeting
- Thomas Kulik
Attending
@Andrea Visnyei@Timo Perala@Thomas Kulik @Eric Debeau
Topic | Notes / Status / Follow-up |
|---|---|
Topics / Quick Notes | @Timo Perala has invited representatives from the ARC subcommittee to discuss the Wiki/RTD topic on the doc weekly call Dec 9, 2021 . @Byung-Woo Jun is unfortunately out-of-office until 2022. @Gergely Csatari will then present the proposal for exporting Wiki pages and converting the to RST @Andrea Visnyei has left the #doc team because of other priorities. Thank you, Andrea, for all your good contribution here. @Timo Perala will continue Andreas work. @Eric Debeau plans to continue on the (swagger) API documentation. There is need for a discussion with @Cédric Ollivier about linting swagger files. Review & feeback (still) welcome for:
Main target for @Thomas Kulik is to improve the release management process (generally and specific to documentation). |
AGENDA FOR TODAY | |
Current JJB/RTD Build Problems | @Cédric Ollivier gave an explanation of the pb (mainly lfdocs-conf) ONAP does not leverage upper-constraints see also https://gerrit.onap.org/r/c/dcaegen2/+/124578 TASKS: LFIT to downgrade sphinx to 3.4 LFIT to downgrade setuptools to 57.4 LFIT to create gates to verify changes all ONAP projects: reduce requirements.txt; add upper-contraints ?: find central place for upper-constraints.os.txt ?: maintain our own upper-constraints because ?? ?: sync tox.ini ?? |
Honolulu Maintenance Release | @Andreas Geißler TASKS: @Andreas Geißler will ask SO and CDS projects to finalize the Docker creation and documentation it is also important to document the process (later on used in a procedure) => P02: Create documentation for an ONAP maintenance release (doc project team) Checking the Project RNs for the Honolulu Maintenance Release: SO (https://docs.onap.org/projects/onap-so/en/honolulu/release-notes.html#release-notes) - update 2021-09-15; version numbering? but OK CCSDK/CDS (https://docs.onap.org/projects/onap-ccsdk-distribution/en/honolulu/release-notes.html#release-notes) - OK Multicloud (https://docs.onap.org/projects/onap-multicloud-framework/en/honolulu/release-notes.html#release-notes) - existing, but version 8.1.0 instead of 8.0.1, but OK OOM (https://docs.onap.org/projects/onap-oom/en/honolulu/release-notes.html#release-notes) - OK Policy (https://docs.onap.org/projects/onap-policy-parent/en/honolulu/release-notes.html#release-notes) - OK DCAE (https://docs.onap.org/projects/onap-dcaegen2/en/honolulu/sections/release-notes.html#release-notes) - OK OOF (https://docs.onap.org/projects/onap-optf-osdf/en/honolulu/sections/release-notes.html#release-notes) - OK pls check, merge and cherrypic for Honolulu https://gerrit.onap.org/r/c/ccsdk/distribution/+/124629 merged to Master; cherry picked to Honolulu https://gerrit.onap.org/r/c/optf/osdf/+/124628 merged to Master; NOT cherry picked yet; proposed to cherry pick |
Istanbul Release | #doc team: Review Istanbul release notes and project content @Eric Debeau and @Andreas Geißler reviewed and document the results in Istanbul Documentation => some comments from @Andreas Geißler Some projects to move on "Unmaintained" mode (ExternalAPI, VID) TASKS: @Eric Debeau Still clarification required for Architecture section (Architecture subcommittee) @Eric Debeau Modeling update to be checked @Eric Debeau clarification on MSB status @Eric Debeau @Andreas Geißler Eric Update conf.py file |
Doc Procedures | Procedure "P01: Create documentation for an ONAP main release" is currently under development by @Thomas Kulik A dedicated procedure related for Maintenance Release: P02: Create documentation for an ONAP maintenance release (doc project team) has been created |
Architecture Documentation in RTD | There is the need to move finalized ONAP architecture documentation from DevWiki to RTD. Especially the following section are from interest (examples from the Istanbul release): Evaluation started; Confluence has now a new functionality to export a page to markdown format; lets see if/how this can help (attachements unfortunately are not included) Pending pach: https://gerrit.onap.org/r/c/doc/+/123946. @Eric Debeau did some comments TASKS:
|
Backlog Clean/Sort/Reorder | We will do it in jira! TASKS: @Thomas Kulikhas prepare a deduplicated and sorted list of open tasks. Next step is to go through the list and remove outdated/unwanted entries. |
Issue with RTD TOC | TASKS: @Andrea Visnyei / @Thomas Kulik check RTD TOC for https://docs.onap.org/en/latest/guides/onap-developer/how-to-use-docs/templates.html |
Doc Templates | TASKS: @Andrea Visnyei and @Andreas Geißler to check current component template and improve if needed |
API Documentation | @Andy Mayer presentation, Developing ONAP API Documentation @Andy Mayer gave us a good introduction to API documentation TASKS: @Eric Debeau to check available API documentation in RTD and how to update with material proposed by @Andy Mayer doc team; next steps: (update) description how to include it in RTD; prepare sample config files; check if we need to create a procedure for this (like we have it for creating main/maintenance release documentation) example RTD link: https://docs.onap.org/projects/onap-ccsdk-oran/en/latest/offeredapis/pms-api.html |
Doc Guideline | TASKS: Ask users to add always the original file of grafics to the repo (plus the bitmap version of course which is used in wiki/RTD) |
Usage of Confluence "Tasks" in Meeting Notes | Please do not use "Tasks" in this meeting note. The meeting note is planned to be copied for the next meeting. Unfortunately all "Tasks" are also copied and a NEW INSTANCE of this tasks is created. This leads to multiple duplicated of a single tasks. |
Other | TASKS:
|
Vacations & Upcoming Meetings |
|