Structure of the OVN documentation

Bug #1976367 reported by Frode Nordahl
6
This bug affects 1 person
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.

Revision history for this message
Peter Matulis (petermatulis) wrote :

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.

Changed in charm-deployment-guide:
importance: Undecided → Medium
status: New → Confirmed
Changed in charm-deployment-guide:
status: Confirmed → In Progress
assignee: nobody → Peter Matulis (petermatulis)
affects: charm-deployment-guide → charm-guide
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to charm-guide (master)

Reviewed: https://review.opendev.org/c/openstack/charm-guide/+/850948
Committed: https://opendev.org/openstack/charm-guide/commit/548aafcaa6eeaf83616768b81d81db11cfbf5b22
Submitter: "Zuul (22348)"
Branch: master

commit 548aafcaa6eeaf83616768b81d81db11cfbf5b22
Author: Peter Matulis <email address hidden>
Date: Mon Jul 25 16:48:19 2022 -0400

    Refactor OVN documentation

    The OVN documentation consists of a single 17-page
    page. This PR refactors it.

    A subdirectory ('ovn') was created and the existing main
    page ('ovn.rst') was renamed to 'index.rst' .

    A content review of these pages will constitute a
    separate PR and will occur soon after.

    Closes-Bug: #1976367
    Change-Id: Ie55e52754e5b8f6d421f7326a123c56d4e2946b0

Changed in charm-guide:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.