Skip to content

[WIP] Add versioning capabilities for our documentation#24

Open
gagnonanthony wants to merge 1 commit intonf-neuro:mainfrom
gagnonanthony:feat/versioning
Open

[WIP] Add versioning capabilities for our documentation#24
gagnonanthony wants to merge 1 commit intonf-neuro:mainfrom
gagnonanthony:feat/versioning

Conversation

@gagnonanthony
Copy link
Member

@gagnonanthony gagnonanthony commented Mar 7, 2025

Once we start making new releases of nf-neuro, we should be able to version our documentation to keep track of when changes happen. This PR sets it up it will look like this:

image

image

However, there are a couple of things to fix before merging it:

@AlexVCaron @arnaudbore

@AlexVCaron
Copy link
Contributor

We could use the repo releases to save the state of the whole documentation at a given version (or latest if no version) when we build it. The coalesed versions can be saved either in the workflows cache or in an artifact, if a version tag is given. Then, when we build the site for deployment, we simply patch the build with the cached content.

@AlexVCaron
Copy link
Contributor

Also, the version tag should come from nf-neuro. When we create a new version there, we automatically create and tag a new version of the documentation here and everything aligns.

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

Successfully merging this pull request may close these issues.

2 participants