tl;dr : VPP's doc, no more doxygen, only sphinx, automated deploys & better fd.io site, check the preview at [0]
Hi everyone, We spent some time during the past weeks improving VPP's documentation with Dave Wallace & Andrew Yourtchenko. Main goals of the exercise were to make the documentation easier to consume for VPP's users, friendlier to update by contributors, and smoother from a CI standpoint. Getting documentation published should be as easy as : * Creating a .rst file in your code folder * Symlinking it at the right place in the docs/ folder * Merging the patch This resulted in a first preview [0] sitting on top of a revamped fd.io site. Main patches are : - the main documentation patch [1] which now contains a `extras/scripts/check_documentation.sh` script. It sits on top of a few patches translating existing markdown to reStructuredText and nitfixing things - an evolution of the fd.io website [2] This work also relies on evolutions to the CI [3] (thanks a lot Dave & Andrew for this !) and to the infra hosting the docs, in order to make docs-checking & docs-publishing fast & runable on every patch. We're planning on discussing this during the next Community meeting, but feel free to share comments & feedbacks in replies to this email. Cheers -Nathan [0] https://deploy-preview-102--fdio.netlify.app/docs/vpp/master/index.html [1] https://gerrit.fd.io/r/c/vpp/+/33545 [2] https://github.com/FDio/site/pull/104 [3] https://gerrit.fd.io/r/c/ci-management/+/33992
-=-=-=-=-=-=-=-=-=-=-=- Links: You receive all messages sent to this group. View/Reply Online (#20309): https://lists.fd.io/g/vpp-dev/message/20309 Mute This Topic: https://lists.fd.io/mt/86234608/21656 Group Owner: vpp-dev+ow...@lists.fd.io Unsubscribe: https://lists.fd.io/g/vpp-dev/unsub [arch...@mail-archive.com] -=-=-=-=-=-=-=-=-=-=-=-
