...
We strive for an aligned view on the fields of improvement and their prioritization.
Challenges
Content
...
Software related content (Wiki, RTD)
- hard to find due to the split between Wiki and RTD
- still available (and publicly editable) in the Wiki even after transfer to RTD
- partly outdated
- partly incomplete
- partly missing at all
- E2E doc partly missing
- even in the case all single (functional) projects would be well documented, we need end-to-end documentation that explains (user) processes / use cases holistically (spanning over several ONAP modules)
- no QA in the release process
...
Projects related content (Wiki)
- partly outdated project profiles
- relation to a specific release unclear
- project scope might evolve over time; no info about this
- activity state unclear
...
- no known solution to convert Wiki content automatically to the RST format
- Wiki as a dev environment for doc?
- Problem: linking to other doc elements (rst) possible?
Building (RST)
- approx. 1500 build errors (@RTD only, elalto-verify-13.11.2019)
- warnings are ignored
- failed builds are not recognized
- currently one large build which includes all project doc as submodules
- expertise for doc tooling & process is no longer available
- no QA in the release process
...