Date
doc-archnav-2021-06-15.mp4
Attendees
Goals
Discussion items
- Main issue - two sources for documentation -
- Wiki for developer based docs
- hard to find things
- gets out dated very quickly
- also has some production documentation that shouldn't be there
- Readthedocs is the formal documentation
- May also want to look at how to better structure the wiki as part of this effort
- ArchNav is intended to help people find the information and not recreate it
- Just a presentation layer to group and organize the information into something that is easily searchable
- NICHOLAS KARIMI MUIGAI will be attending both the Doc and Arch meetings
- Chaker Al-Hakim provided an overview of ArchNav https://safratech.net/onapdocs/
- Navigator framework aimed at visually guiding users to specific projects in the documentation
- Thomas Kulik consensus that some type of "portal" is necessary to group and present information
- concerns on how to maintain ArchNav since much of the work is not automated
- Are multiple instances a potential solution?
- Doc team cannot manage the maintenance effectively - minimal resources available to do the work
- Chaker Al-Hakim alignment on challenges but some issues are mutually exclusive. Integration is what brings the usefulness across the entire doc set
- May want to include wiki structure improvements as one aspect of the project - TBD
- May want to discuss how to better enable documentation as a whole - potential leadership opportunity from the LF
Action items
