Skip to content
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

Change the slug for the theme.json doc to avoid conflicts #57410

Merged
merged 8 commits into from
Dec 28, 2023

Conversation

ndiego
Copy link
Member

@ndiego ndiego commented Dec 27, 2023

It turns out that each doc slug needs to be unique. A new theme.json doc was created in #57289 and the slug was simply theme-json, which already existed. Therefore, the new doc was not synced to the Handbook.

This PR modifies the slug to theme-json-configurations, thus making it unique.

Edit: Following the comment below, I have updated the approach in this PR to instead change the slug of the Global Settings & Styles doc. While updating that doc, I also removed an unnecessary TOC.

Warning

I have also created the redirect PR here: WordPress/wporg-developer#457. This PR should be merged at the same time the redirect PR is put in place.

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label Dec 27, 2023
@ndiego ndiego self-assigned this Dec 27, 2023
@t-hamano
Copy link
Contributor

I feel it's better if the slug is based on the page title. The title of the page added in #57289 is "Global Settings & Styles (theme.json)", but the page title and slug are theme-json. How about changing this to global-settings-and-styles to avoid duplication?

In other words, the classification is as follows.

Page Title How-to Guides > Themes > Global Settings & Styles (theme.json) How-to Guides > Curating the Editor Experience > theme.json
Slug global-settings-and-styles theme.json
Source ../docs/how-to-guides/themes/global-settings-and-styles.md ../docs/how-to-guides/curating-the-editor-experience/theme-json.md

Reference: Similar page in the theme handbook

@ndiego
Copy link
Member Author

ndiego commented Dec 28, 2023

I feel it's better if the slug is based on the page title. The title of the page added in #57289 is "Global Settings & Styles (theme.json)", but the page title and slug are theme-json. How about changing this to global-settings-and-styles to avoid duplication?

Yeah, I do like that better. Good call @t-hamano. This will require a new redirect to be put in place. I will get this PR and the redirect PR put together today.

@ndiego ndiego requested a review from t-hamano December 28, 2023 12:42
@ndiego
Copy link
Member Author

ndiego commented Dec 28, 2023

@t-hamano I have updated this PR based on your suggested approach. I have also created the redirect PR here: WordPress/wporg-developer#457. This PR should be merged at the same time the redirect PR is put in place.

Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made a few suggestions regarding links, and overall things seem fine 👍

In addition to this, I suspect that the link below is also not working properly.

Link support has been made stable as part of WordPress 5.8. It's `false` by default and themes can enable it via the [theme.json file](./theme-json.md):

Perhaps /docs/how-to-guides/curating-the-editor-experience/theme-json.md rather than ./theme-json.md?

docs/how-to-guides/themes/theme-support.md Outdated Show resolved Hide resolved
docs/reference-guides/block-api/block-supports.md Outdated Show resolved Hide resolved
docs/reference-guides/block-api/block-supports.md Outdated Show resolved Hide resolved
ndiego and others added 6 commits December 28, 2023 11:04
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
…upports.md

Co-authored-by: Aki Hamano <54422211+t-hamano@users.noreply.github.com>
@ndiego
Copy link
Member Author

ndiego commented Dec 28, 2023

Perhaps /docs/how-to-guides/curating-the-editor-experience/theme-json.md rather than ./theme-json.md?

Good catch, missed that one. All updated.

@t-hamano t-hamano self-requested a review December 28, 2023 17:09
Copy link
Contributor

@t-hamano t-hamano left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🚀

@ndiego ndiego merged commit 83e1a2c into trunk Dec 28, 2023
56 checks passed
@ndiego ndiego deleted the docs/fix-curation-theme-json-doc-url branch December 28, 2023 22:52
@github-actions github-actions bot added this to the Gutenberg 17.5 milestone Dec 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants