jimporter / mike

Manage multiple versions of your MkDocs-powered documentation via Git
BSD 3-Clause "New" or "Revised" License
547 stars 47 forks source link

Improve usability on non-Github forges #202

Open jimporter opened 8 months ago

jimporter commented 8 months ago

In light of Github cofounder defunkt being (temporarily) banned from Github, I think it's time to ensure that users of mike can easily migrate to other Git forges. No one should be locked into a forge with capricious moderation practices. The first step will be surveying other forge software and figuring out which ones we should support (and to what level). Here's a tentative list:

Tier 1

Tier 2


A lot of the work here is probably just documenting what to do, but it might require some adjustment depending on the forge. For example, I think Sourcehut only provides users with a single site for all their projects, so we'd need to do a bit of work to ensure that each project deployed to Sourcehut via mike gets its own subdirectory.

ynedelec commented 5 months ago

Hello,

Could you please write some documentation for integrating with GitLab CI ? I've been trying this solution: https://github.com/jimporter/mike/issues/25 but unfortunately it seems mike evolved in-between and the --rebase option is not available anymore.

I'm not good enough in git-fu to find a proper workaround :(

Thanks

jimporter commented 5 months ago

Anyone using --rebase is (or rather "was") almost certainly using mike wrong, since --rebase was nearly impossible to use correctly (which is why I removed it). All you should need to do is make sure your CI job's Git clone has the gh-pages branch: git fetch origin gh-pages --depth=1.

(In the extremely-rare scenario that rebase is really the right move, it's probably better to use git rebase directly.)