Skip to content

Documentation issues #99

@otroan

Description

@otroan
  1. The main documentation page is ugly. https://fd.io/documentation/ It's difficult to find the VPP documentation.
  2. Where to store documentation? Is it fine to keep it on github? Currently half of the documentation is in VPP repo and some parts on github, and the developer documentation is on nexus.
  3. Pointer from documentation to featurelist. Ensure feature list is marked with generation date / version
  4. Automatically update documentation for master per patch
  5. Automate documentation for release. Currently requires manually updating config.toml, content/documentation/vpp.md, content/vppProject/vppbuilding/vpp.md and vpp/docs/conf.py
  6. A google returns lots of very old links, back to 17.04.
  7. What about vpp.readthedocs.io?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions