You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
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.
The text was updated successfully, but these errors were encountered: