Structure of the OVN documentation
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
OpenStack Charm Guide |
Fix Released
|
Medium
|
Peter Matulis |
Bug Description
The OVN section of the Charm Deployment Guide is currently structured as a single page with multiple quite different topics.
1)
This can be confusing, especially for the Hardware Offload and SR-IOV topics.
These two technologies use similar building blocks, but are quite different in how they should be set up, and having these two sections right after each other with cross references may easily guide users to an incorrect configuration.
2)
The fact that reboot is required before some of the features can be consumed is mentioned in the documentation but users appear to miss this step still.
We need to find a way to highlight this further and perhaps also include rationale as to why and our long term goal of configuring these things from MAAS so that a post deploy reboot can be avoided.
Changed in charm-deployment-guide: | |
status: | Confirmed → In Progress |
assignee: | nobody → Peter Matulis (petermatulis) |
affects: | charm-deployment-guide → charm-guide |
Hi Frode. I agree that the current page is too long and should be broken up. I propose an overview page and a few sub-pages. With this design in mind, could you offer specific guidance on content management? Once that's done it won't be hard to publish a refactored set of docs.
p.s.
The current monolithic page will soon be migrated to the charm-guide so this bug will simply be re-applied to the charm-guide project.