-
Notifications
You must be signed in to change notification settings - Fork 803
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
docs: 100% MyST Markdown #1974
Merged
consideRatio
merged 48 commits into
jupyterhub:master
from
consideRatio:pr/rst-to-markdown
Jan 4, 2021
Merged
docs: 100% MyST Markdown #1974
consideRatio
merged 48 commits into
jupyterhub:master
from
consideRatio:pr/rst-to-markdown
Jan 4, 2021
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
consideRatio
force-pushed
the
pr/rst-to-markdown
branch
from
January 4, 2021 05:59
2687cb0
to
2474b0f
Compare
choldgraf
approved these changes
Jan 4, 2021
consideRatio
force-pushed
the
pr/rst-to-markdown
branch
from
January 4, 2021 09:17
2474b0f
to
06ea1d6
Compare
consideRatio
force-pushed
the
pr/rst-to-markdown
branch
2 times, most recently
from
January 4, 2021 10:17
add68c8
to
2db6d01
Compare
consideRatio
force-pushed
the
pr/rst-to-markdown
branch
from
January 4, 2021 10:20
2db6d01
to
6689137
Compare
consideRatio
pushed a commit
to jupyterhub/helm-chart
that referenced
this pull request
Jan 4, 2021
jupyterhub/zero-to-jupyterhub-k8s#1974 Merge pull request #1974 from consideRatio/pr/rst-to-markdown
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With MyST being quite mature in my mind and a rst-to-myst parser available, I felt it was time to transition to it entirely. @choldgraf introduced it to this repo a while back, and for me, the experience has been great overall and I much prefer it over rST.
I'm confident it will be a positive experience overall for this Jupyter project to rely on a Markdown based documentation system rather than rST based documentation system. We truly need contributors to the guide for sustainability, so it's a big deal in my mind to make it easier for them by consistently using MyST markdown.
There is one .rst file that remain, which is updated in #1943.
PR summary
rst-to-myst CLI conversions
pip install rst-to-myst
git mv file.rst file.md
git commit -m "docs: move file.rst to file.md
rst2myst parse -f file.md > file.md_tmp
mv file.md_tmp file.md
git add file.md
git commit -m "docs: rst2myst on file.md
I submitted notes about the rst2myst CLI to executablebooks/rst-to-myst#11.
Misc changes
I found quite a few unreferenced images in the _static/images folder, I moved them to a folder indicating they were unreferenced by the docs and can be removed.
Related
I opened a discussion about rst/myst conversions before in the team-compass, it is in jupyterhub/team-compass#350.