search

FDio / site

Apache License 2.0
6 stars 23 forks source link

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

Open ayourtch opened 3 years ago

ayourtch commented 3 years ago

created from https://github.com/FDio/site/issues/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 commented 3 years ago

@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 ?