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

Create a new handbook page for curating the editor experience #42022

Merged
merged 12 commits into from
Jul 4, 2022

Conversation

annezazu
Copy link
Contributor

What?

This proposes a v1 of a new page that compiles various methods for curating the editor experience. Thanks to @justintadlock @carolinan @bph for chiming in/reviewing! In the future, I'd love to see a section with specific recommendations for Agencies and Enterprise level folks. My hope is that an initial version can get out into the open and folks in those spaces can contribute back with use studies, feedback on what would be helpful, etc.

Why?

Right now, the information around how best to curate the experience/tailor it to your needs is spread across multiple different resources. This seeks to pull them into one place and explain how they each can be used.

Please help with this PR!

I still struggle at times to get things in place for new docs so, if you're game to help, it would be lovely for folks to contribute to this PR both to move it forward and suggest changes.

This proposes a v1 of a new page that compiles various methods for curating the editor experience.
@annezazu
Copy link
Contributor Author

Noting that I definitely added the visuals incorrectly (didn't see the assets folder). I'll try to figure this out now :)

annezazu added 3 commits June 28, 2022 11:20
Had to speed this video up in order for it to be small enough to include.
I can't seem to figure out why the video won't properly render. When I look at the individual file, it seems the size is still too big to display. If I don't add it to the assets file and just drop it in, it works though.
@annezazu
Copy link
Contributor Author

I can't seem to figure out why the video won't properly render. When I look at the individual file, it seems the size is still too big to display. If I don't add it to the assets file and just drop it in, it works though. If anyone can help here, that would be rad :)

Copy link
Member

@fabiankaegy fabiankaegy left a comment

Choose a reason for hiding this comment

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

I really like this guide. It is a great overview of the various options that one has :)


Beyond defining default values, using theme.json allows you to also remove options entirely and instead rely on what the theme has set in place. Below is a visual showing two extremes with the same paragraph block:

![Image of restricted interface](https://github.com/WordPress/gutenberg/blob/annezazu-curate-new-doc/docs/assets/Locking%20comparison%20visual.png)
Copy link
Member

Choose a reason for hiding this comment

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

I think the URL of the image already needs to point to the path of the image once it has been merged to trunk.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah! Okay. Let me update that :) I just was worried they wouldn't appear if I reference them in trunk without them being there first. Makes sense though.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated but, as you can see now, the images don't show up. I guess that's what has to be done but I'm not sure what folks have done previously.

@annezazu annezazu requested a review from Mamaduka July 1, 2022 21:11
annezazu added 2 commits July 1, 2022 14:13
Not sure if this is the right way to resolve a conflict with trunk but this is my attempt :)
@bph bph added this to the Gutenberg 13.7 milestone Jul 3, 2022
@gziolo
Copy link
Member

gziolo commented Jul 4, 2022

You need to run npm run docs:build to regenerate the manifest file used at https://developer.wordpress.org/block-editor/.

@ryanwelcher
Copy link
Contributor

You need to run npm run docs:build to regenerate the manifest file used at https://developer.wordpress.org/block-editor/.

@annezazu I took the liberty of rebuilding the docs and pushing the changes up.

Copy link
Contributor

@ryanwelcher ryanwelcher left a comment

Choose a reason for hiding this comment

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

LGTM! 👍

@annezazu annezazu merged commit 16533b7 into trunk Jul 4, 2022
@annezazu annezazu deleted the annezazu-curate-new-doc branch July 4, 2022 17:55
annezazu added a commit that referenced this pull request Aug 23, 2022
Similar to #42022, this proposes a v1 of a new page that discusses how best to manage propagating updates to your site. The aim is for an initial version to be shared that can then evolve over time to be more comprehensive as needed.
annezazu added a commit that referenced this pull request Sep 6, 2022
* Create a new handbook page for propagating updates

Similar to #42022, this proposes a v1 of a new page that discusses how best to manage propagating updates to your site. The aim is for an initial version to be shared that can then evolve over time to be more comprehensive as needed. Assistance from @justintadlock @gziolo @juanmaguitar @ryanwelcher. 

* Update manifest.json for new doc

* Update toc.json for new handbook page

* Text updates

* Updating the blocks section

Updating based on great feedback from @gziolo.

* Updating bolding and headers

Updating the structure of the doc in light of @juanmaguitar's feedback.

* Updating title of page

* Updating manifest.json with new title

* Rebuild docs.

Co-authored-by: Ryan Welcher <[email protected]>
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.

5 participants