Convert docs from reStructuredText to MyST markdown #2980
Merged
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
zebot
added
the
ok-to-test
smatting
force-pushed
the
convert-docs-to-md
branch
from
1b3cb6f to
8906b2f
Compare
smatting
force-pushed
the
convert-docs-to-md
branch
from
8906b2f to
ca8cf60
Compare
jschaul
reviewed
Jan 12, 2023
| @@ -128,6 +128,5 @@ | |||
| "security-responses/log4shell": "2021-12-15_log4shell.html", | |||
| "security-responses/cve-2021-44521": "2022-02-21_cve-2021-44521.html", | |||
| "security-responses/2022-05_website_outage": "2022-05-23_website_outage.html", | |||
| "how-to/single-sign-on/index": "../../understand/single-sign-on/main.html#setting-up-sso-externally", | |||
| "how-to/scim/index": "../../understand/single-sign-on/main.html#user-provisioning", | |||
| "how-to/scim/index": "../../understand/single-sign-on/main.html#user-provisioning" | |||
There was a problem hiding this comment.
These links are for people who may have bookmarked old URLs, they then get a redirect and the old links still work.
I'm not sure how important this is; but it's certainly nice user experience if previous links someone may have saved/bookmarked still work. Perhaps we should add a comment here for the next person stumbling over this
There was a problem hiding this comment.
I thought about this, since how-to-/single-sign-on/index now points to https://docs.wire.com/how-to/single-sign-on/index.html which is a nice index of all thing sso I thought it's okay enough
|
Cool beans! 😃 |
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.
The conversition was perfomed with rst-to-myst.
A lot of manul preparation work was needed and has been squashed into a single commit.
I've QA'd the result using selenium to obtain screenshots of each of the 115 pages and diffing them with Imagemagick against the screenshots of the reference pages from http://docs.wire.com.
For non-trivial diffs I've inspected manually to find problems and fix.
The result builds with only a few warnings concerning duplicated labels and some minor layout problems, which I'll fix in a followup PR.
The scripts to convert and generate the screenshots are included in the
convert/directory.