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

vppdoc: The "home" and "source of truth" for the VPP documentation #100

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

Comments

@ayourtch
Copy link

created from #99 to keep one-issue-per-issue, in order to make the discussion/tracking easier.

  1. 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.
@ayourtch
Copy link
Author

@otroan so probably worth first to put here some info about "status quo", and how the things are done ?

The developer documentation (e.g. https://docs.fd.io/vpp/21.10/) is, as far as I understand, is merely a bag of files that are fully automatically generated off the VPP repo and pushed to nexus at docs.fd.io

The other half is the manually-updated hugo-made site from source in https://github.com/FDio/site/tree/master/content/documentation - which is subsequently pushed into https://fd.io/documentation/

Are there other sources / destinations / workflows and if yes - what are they ?

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

1 participant