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

Break out the Curating the Editor Experience doc into its own How-to Guides section #57289

Merged
merged 6 commits into from
Dec 27, 2023

Conversation

ndiego
Copy link
Member

@ndiego ndiego commented Dec 20, 2023

This PR is an initial implementation of the concept outlined in #56170.

V1: Divide and solidify

Break each logical section into individual pages (locking APIs, providing default controls/options, etc) and add in more content/links to articles/video that we already have from the Developer Blog (no new content!).

I have taken the Curating the Editor Experience doc and made it its own section in How-to Guides. I have then broken the doc up into five additional docs.

  1. Block locking
  2. Patterns
  3. theme.json
  4. Filters and hooks
  5. Disabling Editor functionality

The last section is a bit of a catch-all that covers miscellaneous curation techniques not covered in the other sections. I did add some new content here about disabling block variations and styles.

Let me know what you think of this initial iteration. The next step will be to go through each sub-doc and overhaul the content with additional information, new examples, etc.

@ndiego ndiego added the [Type] Developer Documentation Documentation for developers label Dec 20, 2023
@ndiego ndiego self-assigned this Dec 20, 2023
@ndiego ndiego changed the title Break out the Curating the Editor Experience doc into it's own How-to Guides section Break out the Curating the Editor Experience doc into its own How-to Guides section Dec 20, 2023
Copy link

github-actions bot commented Dec 20, 2023

Flaky tests detected in 5f4ad6c.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/7281194916
📝 Reported issues:

@ndiego ndiego marked this pull request as ready for review December 20, 2023 23:09
Copy link
Contributor

@annezazu annezazu left a comment

Choose a reason for hiding this comment

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

Approving but left two minor comments :) Thank you for moving this forward.

@@ -0,0 +1,210 @@
# theme.json
Copy link
Contributor

Choose a reason for hiding this comment

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

Find the lower case t to throw me off here. Any reason not to capitalize?

Copy link
Contributor

Choose a reason for hiding this comment

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

I haven't tested across different systems, but I'd always err on the side of preserving the correct case for filenames.

Copy link
Member Author

Choose a reason for hiding this comment

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

I haven't tested across different systems, but I'd always err on the side of preserving the correct case for filenames.

Yeah, we are doing the same thing with other common filenames like block.json, functions.php, etc. That said, we do need to comb through the Handbook and standardize this.

@ndiego ndiego enabled auto-merge (squash) December 27, 2023 20:16
@ndiego ndiego merged commit 53f7f20 into trunk Dec 27, 2023
54 of 55 checks passed
@ndiego ndiego deleted the doc/break-out-curation-docs branch December 27, 2023 20:41
@github-actions github-actions bot added this to the Gutenberg 17.5 milestone Dec 27, 2023
@annezazu
Copy link
Contributor

🥳 Thanks for getting this done!

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.

4 participants