Attending
Kenny Paul , Sofia Wallin , Andreas Geissler , Ken KANISHIMA , Thomas Kulik , Sriram Rupanagunta , Timo Perala Brandon Wick
This meeting will be decided to the community technical writer discussion.
...
Topics, Notes, Status and Follow-Up Tasks
Topic | Notes / Status / Follow-up |
---|
Doc Writer SOW Kenny Paul | Budget available. To be focused on operational parts. depth rather than |
width Next weeks meeting Meeting will be dedicated this topic. Kenny Paulto |
invite @Brandon @Amar Amar Kapadia Sofia Wallin asked who owns the resources and the workforce/project Suggestions by the doc project based on community feedback and the work done by the doc project: - Need to ensure that this is not a general bucket where people think they can just throw all doc issues at the writer.
- API documentation not included in SOW
- Modeling team has provided the "how to document APIs"
- Topic based documentation
- Re-structure current content to improve usability. Helping end users and other interested to easy find what they are looking for
- Review with the team next week what's available today and based on that come up with a work plan
- Is this content creation only or also clean-up? Adding more content or structure clean up ?
- SOW
- Review of existing documentation - lots of content wiki RTD
- 6 month SOW proposed
- Proposed topics
- I think the work matches the proposed team size quite well.
- We can have 0.5 person on basics,
- 1.5 persons on deep dive,
- 1 person on the ops stuff (install, upgrade; backup, restore).
- documentation,exercise. not debug+documentation, or development+debug+documentation
- Prioritization
- 1 Walkthrough the basics (high-level architecture, short description of each component)
- "core implementation bundle" description
- 2 Deep dive tutorials of the more mature components priorities:
- how to use SDC - design time is important, gaps in control-loop, known resource limitations on the project. May have some legacy docs that ncan be leveraged and updated,
- how to use DCAE - required for design time
- 3 Installation & upgrade procedure
- E2E from download, install, create and 1st service instance up and running (hello world)
- "core implementation bundle" description
- E2E how to upgrade: OOM guides exist but can be improved
- 4 Backup, upgrade and restore procedure
- common guideline for the ONAP platform
- component specific admin guide
- trying out recipes and documenting them as opposed to having to figure them out from scratch or to debug them
- 5 how to use SO
|