Open-Cap-Format-OCF icon indicating copy to clipboard operation
Open-Cap-Format-OCF copied to clipboard

[Enhancement]: Look Into Versioning Our Documentation in MkDocs

Open JSv4 opened this issue 2 years ago • 2 comments

Description of Enhancement :

Our current doc pipeline just publishes the most recent version of the documentation. We should create a script as part of our release scripts to release versioned docs.

Why is this Needed?

Developer-friendly docs

Anything else we need to know?

JSv4 avatar May 02 '23 16:05 JSv4

@pjohnmeyer I am wondering how should we trigger the deployment of the documentation once a release is created. Currently we have branch for release-v1.1.0 and a tag v1.1.0. Any suggestion which one is better to use as a trigger for the documentation versioning deployment?

xudiera avatar Jul 25 '23 16:07 xudiera

@xudiera the branch is made first in order to run the various tools and update the versions, etc., and make a commit. The tag is added to the commit with the necessary URL and id changes, so the tag should probably be the trigger.

pjohnmeyer avatar Aug 10 '23 21:08 pjohnmeyer