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

Fix #13288: Convert docs to mkdocs #13872

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

pmac
Copy link
Member

@pmac pmac commented Nov 8, 2023

Preview the new docs here https://pmac.github.io/bedrock/

@pmac pmac force-pushed the sphinx-to-mkdocs-material branch from 61c927d to 31c47d1 Compare November 9, 2023 00:17
@reemhamz
Copy link
Contributor

reemhamz commented Nov 9, 2023

Excited for this change 🎉

@alexgibson
Copy link
Member

There's an issue for this here if you wanna reference / close it when this merges: #13288

Nice work!

@pmac
Copy link
Member Author

pmac commented Nov 9, 2023

Thanks y'all. Hoping to get a demo up somewhere today so folks can test drive it.

@pmac pmac changed the title Convert docs to mkdocs Fix #13288: Convert docs to mkdocs Nov 9, 2023
@pmac
Copy link
Member Author

pmac commented Nov 9, 2023

One big question is where to host the new docs. It's easy to host them at GH Pages with a documented GH Action, but that would put them at mozilla.github.io/bedrock/. If we do that what do we do with bedrock.rtfd.org? Just delete it? Update those docs to just say that we've moved and link to the new one? Or do we try to get ReadTheDocs to build and host the new docs?

@pmac
Copy link
Member Author

pmac commented Nov 9, 2023

@pmac pmac force-pushed the sphinx-to-mkdocs-material branch from ec96efa to 5f28069 Compare November 13, 2023 17:57
@pmac pmac marked this pull request as ready for review November 13, 2023 23:13
@pmac pmac force-pushed the sphinx-to-mkdocs-material branch from 6fd178d to d608932 Compare November 13, 2023 23:15
Copy link
Member

@alexgibson alexgibson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a rebase, but moving to markdown looks like a great improvement to me, and the new docs themselves seem like they are definitely more usable. r+!

@alexgibson
Copy link
Member

alexgibson commented Dec 5, 2023

One big question is where to host the new docs. It's easy to host them at GH Pages with a documented GH Action, but that would put them at mozilla.github.io/bedrock/. If we do that what do we do with bedrock.rtfd.org? Just delete it? Update those docs to just say that we've moved and link to the new one? Or do we try to get ReadTheDocs to build and host the new docs?

I'd be cool with hosting them on GitHub via an action, and then updating the old docs to link to the new place 👍

@janbrasna
Copy link
Contributor

@pmac I've mentioned in #13288 (comment) that if you're ok with hosting on rtfd.org and don't mind the occasional ethical-ads in the sidebar you can build&deploy MkDocs to readthedocs via GH Action as well: https://github.com/readthedocs-examples/example-mkdocs-basic#readme

@alexgibson alexgibson added Backend Server stuff yo Frontend HTML, CSS, JS... client side stuff Documentation 📝 Things related to the bedrock documentation labels Jun 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backend Server stuff yo Documentation 📝 Things related to the bedrock documentation Frontend HTML, CSS, JS... client side stuff
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants