[system] Keep track of migrated docs and warn on use #35
Conversation
This file contains hidden or 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
andrewnicols
added
enhancement
andrewnicols
force-pushed
the
warnAboutMigratedPages
branch
from
6bafa9d to
212bf80
Compare
Member
Author
|
To see this in use, add the id of a page from the old docs to the list of docs in |
Member
Author
|
Example output in the Docusaurus runner: |
sarjona
requested changes
Apr 12, 2022
Member
sarjona
left a comment
sarjona
left a comment
There was a problem hiding this comment.
Hi Andrew! Thanks a lot for working on this. The patch is working as expected but, as you'll see, the replacement format is not the expected. It should be [Description](URL)
The commit adds a new migratedPages.js module which includes a list of legacy page to new page mappings. When a legacy link in the Wikimedia internal link format is encountered, it is checked against this list of migrated pages, and an updated page URL is generated. This value is notified to the Docusaurus CLI console, and the updated link is used in the generated documentation.
andrewnicols
force-pushed
the
warnAboutMigratedPages
branch
from
212bf80 to
5aa2f0d
Compare
Member
Author
|
Thanks Sara, I keep making that stupid mistake. Fixed now. |
sarjona
approved these changes
Apr 12, 2022
Member
sarjona
left a comment
sarjona
left a comment
There was a problem hiding this comment.
Thanks Andrew! And here we go, one more feature in our road to migrate dev docs! <3
github-merge-queue bot
pushed a commit
that referenced
this pull request
Nov 5, 2024
Release notes for 4.5.0
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 commit adds a new migratedPages.js module which includes a list of
legacy page to new page mappings.
When a legacy link in the Wikimedia internal link format is encountered,
it is checked against this list of migrated pages, and an updated page
URL is generated.
This value is notified to the Docusaurus CLI console, and the updated
link is used in the generated documentation.