Components: Hide private READMEs from handbook #60003
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
mirka
added
[Type] Developer Documentation
mirka
requested review from
ajitbohra,
ndiego,
ryanwelcher,
juanmaguitar and
fabiankaegy
as code owners
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
|
Size Change: 0 B Total Size: 1.71 MB ℹ️ View Unchanged
|
tyxla
approved these changes
Mar 20, 2024
Noting for posterity: It turns out that the manifest.json handling is non-destructive, so removing entries from the file will not automatically remove it from the published handbook. We currently need to get someone from the Meta team to remove them manually. And if we ever need redirects, we can declare them here. |
carstingaxion
pushed a commit
to carstingaxion/gutenberg
that referenced
this pull request
Mar 27, 2024
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.
What?
Removes private component docs that were unintentionally leaking into the public Block Editor Handbook:
Why?
It is unnecessary and confusing to list still-private components in the handbook, since they are not publicly available yet.
Testing Instructions
This can only be tested by deploying.
Related
For some reason, we can see some published component READMEs that are not in the manifest.json:
I'm guessing this is some kind of caching issue? I don't see anything suspicious in the code responsible for handling the manifest.json, but we may have to escalate this issue if it doesn't resolve in the next deploy.