search

sodafoundation / documentation

Documentation for SODA Foundation and SODA Core projects. Covers code for doc site generation.
https://docs.sodafoundation.io/
MIT License
46 stars 220 forks source link

Support multiple versions of documentation based on project release. #23

Open anvithks opened 4 years ago

anvithks commented 4 years ago

The OpenSDS documentation site is based on Hugo and Netlify.
It was migrated from readthedocs.io
Readthedocs had inbuilt version controlled release mechanism that is not supported out of the box with Hugo/Netlify.
This has been achieved by the Kubernetes.io site and some other sites.
Looking for help to support the versioned releases and easy switching in an automated setup with no manual intervention.

anvithks commented 3 years ago

@skdwriting @kumarashit This was a backlogged issue raised at the start of the new documentation website. I am looking into this now. Unlike readthedocs, Hugo and Netlfiy do not support versioned release of websites out of the box. Netlify allows for branch wise builds and we it also has monorepo support that allows for the same base code to be used for multiple websites. I am exploring this as an option and am trying out build and deploy on my fork with the test releases created there (v1.1.0 and v1.2.0) Netlify supports different build contexts based on branch. I do not know if they support build contexts by release tags (GitHub tags). This approach will ensure that we do not have to make any drastic changes to the way our documentation is currently setup.

If this approach is not feasible, then I shall also look at alternatives that can provide versioned releases of documentation with minimum change to the current setup.