Deprecate the {{index}} macro - #5607
Merged
schalkneethling merged 3 commits intoMar 14, 2022
Merged
schalkneethling merged 3 commits into
schalkneethling merged 3 commits into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
schalkneethling
self-requested a review
March 14, 2022 14:56
Document macro deprecation
Update README.md
schalkneethling
approved these changes
Mar 14, 2022
schalkneethling
left a comment
Copy link
Copy Markdown
There was a problem hiding this comment.
1 Down! Kinda :)
Sorry, something went wrong.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Reviewers
1 more reviewerAssignees
3 participants
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.
Summary
Index pages are no longer a thing in our content.
Problem
We shouldn't maintain outdated wiki macros. However, the macro can only be removed entirely if translations removed all calls to it, so let them know by raising a deprecation error.
Solution
Encourage translators to remove index pages with a MacroDeprecatedError.
How did you test this change?
Put the {{index}} macro on a page and see a flaw like "MacroDeprecatedError from index. Fixable 👍🏼" appearing.
Related
mdn/content#13770