Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support versioning #7

Open
2 tasks done
Siroccomeister opened this issue Sep 28, 2023 · 1 comment
Open
2 tasks done

Support versioning #7

Siroccomeister opened this issue Sep 28, 2023 · 1 comment
Labels

Comments

@Siroccomeister
Copy link

Prerequisites

Proposal

Material for MKDOCS support versioning via mike plugin.
But it is not exactly designed for Gitlab and even less for private Gitlab.

REQUEST
It would be great that the ads-mkdocs-theme could enable versioning across GitHub and GitLab.
Similarly to what ods themed https://boosted.orange.com can do.

Thanks !

Motivation and context

We intend to use ods-mkdocs-theme to combine ODS with Material for MKDOCS.
But the purpose is to build and maintain technical documentation.
In order to have a proper release management, the version feature is important - to drive roadmap and milestones.
Without it - it is a lot more difficult to commit on enhancements.

@julien-deramond julien-deramond changed the title versioning Support versioning Sep 28, 2023
@Siroccomeister
Copy link
Author

I managed to progress on the feature and probably validate that we can make it work.

The versioning is described as per https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/
But it does not exactly work "out of the box" because material doc is tested on GitHub and not GitLab.
For GitLab - you need to create with mike a CI/CD pipeline for the versioning branch "gh-pages" to move the versions from the branch into the public folder. The solution is outlined here and works manually : jimporter/mike#25 (comment)

What still needs to be done :
Each time you push to main, public gets replaced and the versions are removed.
So you need to deploy again with mike to get the files copied over.
This part should get automated with more elaborate CI/CD pipeline templating I think.

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant