Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation issues #99

Open
otroan opened this issue Jul 20, 2021 · 1 comment
Open

Documentation issues #99

otroan opened this issue Jul 20, 2021 · 1 comment

Comments

@otroan
Copy link
Collaborator

otroan commented Jul 20, 2021

  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?
@ayourtch
Copy link

I created #100 for (2), as that item seems to be the most foundational to deal with the first. we can use this issue as a "central documentation meta" to reference all the rest - for the others it makes more sense to have "one issue per issue" so that it is somewhat trackable.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants