Skip to content

Commit

Permalink
Update plugin readme.txt content for intended audience (#38724)
Browse files Browse the repository at this point in the history 
* Add links to intro paragraph

* Rearrange main content into "what does it do" section

* Adds "who is this for" section

* Capitalizes Slack

* Breaks feedback faq into paragraphs for readability

* Breaks "do I need" section into paragraphs and answers question more directly

* Adjusts capitalization and smart quote

* Add link to 2021 SotW post

* Adjust capitalization for consistency

* Add section covering 1-star reviews

* Add FAQ reference to Classic Editor

* Removes Classic Editor FAQ

* Removes 1-star reviews FAQ

* Add test drive link

Gives users a taste of the block editor before committing to installation.

* Move introduction date below intro paragraph

* Move explainer higher in content

* Change heading to focus on benefit

* Add section with focus on contributors

* Remove reference to running in production

* Add more reference to contribution

imho it is good to end the main description with a call for contributors.

* Add reference to FSE

* Add reference to FSE and additional block types

Also break up into separate paragraphs.

* Move test drive to top of list; works better in context of this list

* Remove demo link; page is outdated and updates under consideration

* Clarify that Gutenberg IS the WordPress editor

* Remove confusing reference to WordPress editor; just call it Gutenberg
  • Loading branch information
@ironprogrammer
ironprogrammer authored Mar 21, 2022
1 parent 6dc0bd4 commit 3d07bf6
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions readme.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,25 @@ The Gutenberg plugin provides editing, customization, and site building features

== Description ==

“Gutenberg” is a codename for a whole new paradigm for creating with WordPress, that aims to revolutionize the entire publishing experience as much as Gutenberg did the printed word. The project is following a four-phase process that will touch major pieces of WordPress — Editing, Customization, Collaboration, and Multilingual.
“Gutenberg” is a codename for a whole new paradigm for creating with WordPress, that aims to revolutionize the entire publishing experience as much as <a href="https://en.wikipedia.org/wiki/Johannes_Gutenberg">Johannes Gutenberg</a> did the printed word. The project is <a href="https://wordpress.org/about/roadmap/">following a four-phase process</a> that will touch major pieces of WordPress — Editing, Customization, Collaboration, and Multilingual.

The block editor introduces a modular approach to all parts of your site: each piece of content in the editor, from a paragraph to an image gallery to a headline, is its own block. And just like physical blocks, WordPress blocks can be added, arranged, and rearranged, allowing WordPress users to create media-rich content in a visually intuitive way — and without work-arounds like shortcodes or custom HTML.
Following the introduction of post block editing in December 2018, Gutenberg later introduced full site editing (FSE) in 2021, <a href="https://wordpress.org/news/2022/01/josephine/">which shipped with WordPress 5.9 in early 2022</a>.

The block editor first became available in December 2018. We’re always hard at work refining the experience, creating more and better blocks, and laying the groundwork for the future phases of work. Each WordPress release comes ready to go with the stable features from multiple versions of the Gutenberg plugin, so you don’t need to use the plugin to benefit from the work being done here. However, if you’re more adventurous and tech-savvy, the Gutenberg plugin gives you the latest and greatest, so you can join us in testing bleeding-edge features, start playing with blocks, and maybe get inspired to build your own.
### What Does Gutenberg Do?

Gutenberg is WordPress's “block editor”, and introduces a modular approach to modifying your entire site. Edit individual content blocks on posts or pages. Add and adjust widgets. Even design your site headers, footers, and navigation with full site editing support.

Each piece of content in the editor, from a paragraph to an image gallery to a headline, is its own block. And just like physical blocks, WordPress blocks can be added, arranged, and rearranged, allowing users to create media-rich content and site layouts in a visually intuitive way — and without workarounds like shortcodes or custom HTML and PHP.

We’re always hard at work refining the experience, creating more and better blocks, and laying the groundwork for future phases of work. Each WordPress release includes stable features from the Gutenberg plugin, so you don’t need to install the plugin to benefit from the work being done here.

### Early Access

Are you a tech-savvy early adopter who likes testing bleeding-edge and experimental features, and isn’t afraid to tinker with features that are still in active development? If so, this beta plugin gives you access to the latest Gutenberg features for block and full site editing, as well as a peek into what’s to come.

### Contributors Wanted

For the adventurous and tech-savvy, the Gutenberg plugin gives you the latest and greatest feature set, so you can join us in testing and developing bleeding-edge features, playing around with blocks, and maybe <a href="https://developer.wordpress.org/block-editor/contributors/">get inspired to contribute</a> or <a href="https://developer.wordpress.org/block-editor/how-to-guides/block-tutorial/">build your own blocks</a>.

### Discover More

Expand All @@ -23,28 +37,32 @@ The block editor first became available in December 2018. We’re always hard at

- **Contributors:** Gutenberg is an open-source project and welcomes all contributors from code to design, from documentation to triage. See the <a href="https://developer.wordpress.org/block-editor/contributors/">Contributor's Handbook</a> for all the details on how you can help.

The development hub for the Gutenberg project can be found at <a href="https://github.com/wordpress/gutenberg">https://github.com/wordpress/gutenberg</a>. Discussions for the project are on the <a href="https://make.wordpress.org/core/">Make Core Blog</a> and in the #core-editor channel in Slack, <a href="https://make.wordpress.org/core/tag/core-editor-agenda/">including weekly meetings</a>. If you don’t have a slack account, you can <a href="https://make.wordpress.org/chat/">sign up here</a>.
The development hub for the Gutenberg project can be found at <a href="https://github.com/wordpress/gutenberg">https://github.com/wordpress/gutenberg</a>. Discussions for the project are on the <a href="https://make.wordpress.org/core/">Make Core Blog</a> and in the #core-editor channel in Slack, <a href="https://make.wordpress.org/core/tag/core-editor-agenda/">including weekly meetings</a>. If you don’t have a Slack account, you can <a href="https://make.wordpress.org/chat/">sign up here</a>.

== Frequently Asked Questions ==

= How can I send feedback or get help with a bug? =

We'd love to hear your bug reports, feature suggestions and any other feedback! Please head over to <a href="https://github.com/WordPress/gutenberg/issues">the GitHub issues page</a> to search for existing issues or open a new one. While we'll try to triage issues reported here on the plugin forum, you'll get a faster response (and reduce duplication of effort) by keeping everything centralized in the GitHub repository.
The best place to report bugs, feature suggestions, or any other feedback is at <a href="https://github.com/WordPress/gutenberg/issues">the Gutenberg GitHub issues page</a>. Before submitting a new issue, please search the existing issues to check if someone else has reported the same feedback.

While we try to triage issues reported here on the plugin forum, you’ll get a faster response (and reduce duplication of effort) by keeping feedback centralized in GitHub.

= Do I have to use the Gutenberg plugin to get access to these features? =

It depends on the feature you want to use! Keep in mind that each version of WordPress after 5.0 comes with bundled versions of the Gutenberg plugin, automatically containing new features and changes. If you want the cutting edge features, including more experimental items, you will need to use the plugin. You can <a href="https://wordpress.org/news/2021/04/become-an-early-adopter-with-the-gutenberg-plugin/">read more here</a> about whether using the plugin is right for you.
Not necessarily. Each version of WordPress after 5.0 has included features from the Gutenberg plugin, which are known collectively as the <a href="https://wordpress.org/support/article/wordpress-editor/">WordPress Editor</a>. You are likely already benefitting from stable features!

But if you want cutting edge beta features, including more experimental items, you will need to use the plugin. You can <a href="https://wordpress.org/news/2021/04/become-an-early-adopter-with-the-gutenberg-plugin/">read more here</a> to help decide whether the plugin is right for you.

= Where can I see which Gutenberg plugin versions are included in each WordPress release? =

View the <a href="https://developer.wordpress.org/block-editor/principles/versions-in-wordpress/">Versions in WordPress</a> document to get a table showing which Gutenberg plugin version is included in each WordPress release.

= What's Next for the Project? =
= What’s next for the project? =

The four phases of the project are Editing, Customization, Collaboration, and Multilingual. You can hear more about the project and phases from Matt in his State of the Word talks for <a href="https://ma.tt/2020/12/sotw-2020/">2020</a>, <a href="https://ma.tt/2019/11/state-of-the-word-2019/">2019</a>, and <a href="https://ma.tt/2018/12/state-of-the-word-2018/">2018</a>. Additionally, you can follow the <a href="https://make.wordpress.org/core/tag/gutenberg-new/">biweekly release notes</a> and <a href="https://make.wordpress.org/core/tag/gutenberg-next/">monthly project plan updates</a> on the <a href="https://make.wordpress.org/core/?s=gutenberg">Make WordPress Core blog</a> for more up to date information about what’s happening now.
The four phases of the project are Editing, Customization, Collaboration, and Multilingual. You can hear more about the project and phases from Matt in his State of the Word talks for <a href="https://ma.tt/2021/12/state-of-the-word-in-person/">2021</a>, <a href="https://ma.tt/2020/12/sotw-2020/">2020</a>, <a href="https://ma.tt/2019/11/state-of-the-word-2019/">2019</a>, and <a href="https://ma.tt/2018/12/state-of-the-word-2018/">2018</a>. Additionally, you can follow the <a href="https://make.wordpress.org/core/tag/gutenberg-new/">biweekly release notes</a> and <a href="https://make.wordpress.org/core/tag/gutenberg-next/">monthly project plan updates</a> on the <a href="https://make.wordpress.org/core/?s=gutenberg">Make WordPress Core blog</a> for more up to date information about what’s happening now.


= Where Can I Read More About Gutenberg? =
= Where can I read more about Gutenberg? =

- <a href="http://matiasventura.com/post/gutenberg-or-the-ship-of-theseus/">Gutenberg, or the Ship of Theseus</a>, with examples of what Gutenberg might do in the future
- <a href="https://make.wordpress.org/core/2017/01/17/editor-technical-overview/">Editor Technical Overview</a>
Expand Down

0 comments on commit 3d07bf6

Please sign in to comment.