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

Update main project README #19743

Merged
merged 10 commits into from Feb 10, 2020
Merged

Update main project README #19743

merged 10 commits into from Feb 10, 2020

Conversation

@mkaz
Copy link
Member

mkaz commented Jan 18, 2020

This is the first part of updating the Gutenberg docs to match the current state, I'm going to submit as separate PRs so it focuses discussion for each piece. The Contributors Handbook is the second part for updates.

Description

Update the main project repository readme with various updates that bring it current for now and down the line.

First organized it into a more general getting started recognizing the three levels that people might be coming to the project: as a User, as a Developer, and as a Contributor

For User - added links to the user documentation, support forums, and how to report an issue

For Developer - added links to the developer documentation

For Contributor - simplified the contributor sections and links to the contributors' guide

I removed the links at the bottom since those are mostly dated from when the project was starting out and justifying itself. These links can be included elsewhere for background and context, and not necessarily on the welcoming page.

Types of changes

Documentation.

You can view the rendered version on the branch here

Copy link
Contributor

youknowriad left a comment

Do you think we should do a similar rewrite for readme.txt as well (WordPress repo)

@youknowriad youknowriad requested review from mtias and chrisvanpatten Jan 20, 2020
@michelleweber

This comment has been minimized.

Copy link

michelleweber commented Jan 21, 2020

Just one note:

Get hands on with the block editor, check out the Block Editor live demo

We should be consistent with how "block editor" is capitalized (or not). Otherwise, looks good!

@mkaz

This comment has been minimized.

Copy link
Member Author

mkaz commented Jan 21, 2020

Good suggestion @youknowriad, I updated the plugin readme with similar content.

@mkaz mkaz force-pushed the update/main-readme branch from 92ab48b to 437d0e6 Jan 21, 2020
@mkaz mkaz removed the Needs Copy Review label Jan 21, 2020
readme.txt Outdated Show resolved Hide resolved
@mkaz mkaz force-pushed the update/main-readme branch from 437d0e6 to 43c790f Jan 28, 2020
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
Copy link
Contributor

youknowriad left a comment

This is looking good to me but I'd appreciate validation from others. Thoughts @jasmussen

@jasmussen

This comment has been minimized.

Copy link
Contributor

jasmussen commented Jan 29, 2020

I'm out with a sore throat today, but will take a look first thing in the morning, unless this damn throat keeps me bedside! :D

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
readme.txt Show resolved Hide resolved
readme.txt Outdated Show resolved Hide resolved
readme.txt Outdated Show resolved Hide resolved
@jasmussen

This comment has been minimized.

Copy link
Contributor

jasmussen commented Jan 30, 2020

Left a bunch of comments but the important one is the first paragraph in both the Github MD and the plugin TXT.

In my opinion that first paragraph should:

  • Explain that "Gutenberg" is a codename for the WordPress block editor
  • Explain this is a plugin to test bleeding edge block editor features
  • Explain what the project and the block editor hopes to achieve, the goals
  • Be a little less "we've done it, welcome to the future" and a little more "we're working on it, come help us".

@michelleweber I see you've already helped out. Might we kindly ask for help on that first paragraph? Thank you!

Overall, excellent work, thanks so much for doing this.

Oh, and let's include a better screenshot:

Screenshot 2020-01-30 at 09 51 45

  • It's high res
  • It includes a browser window sans extensions to help add context
  • It hides the sidebar and no blocks are selected, providing for a less "work in progress" feel
  • It uses the 2020 theme
  • I even manually changed the max-width of blocks so as to not have an orphan in the text.

We will very likely want to update that screenshot many times in the future, but until then, the above one is better :)

@michelleweber

This comment has been minimized.

Copy link

michelleweber commented Jan 30, 2020

@jasmussen, what about something like:

Welcome to the development hub for the WordPress Gutenberg project!

"Gutenberg" is a codename for a whole new paradigm in WordPress site building and publishing, one that will revolutionize the publishing experience as much as Gutenberg did the printed word. Right now, the project is in the first phase of a four-phase process that will touch every piece of WordPress -- Editing, Customization, Collaboration, and Multilingual -- and is focused on a new editing experience, the block editor.

The block editor introduces a modular approach to pages and posts: 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 added, arranged, and rearranged, allowing WordPress users to create media-rich pages in a visually intuitive way -- and without work-arounds like shortcodes or custom HTML.

The block editor first became available in December 2018, and we're still hard at work refining the experience, creating more and better blocks, and laying the groundwork for the next three phases of work. The Gutenberg plugin gives you the latest version of the block editor so you can join us in testing bleeding-edge features, start playing with blocks, and maybe get inspired to build your own.

@jasmussen

This comment has been minimized.

Copy link
Contributor

jasmussen commented Jan 30, 2020

Thank you Michelle, your words are wonderful.

Perhaps I'm being overlay Danish (jantelov and so on), but could we change this:

one that will revolutionize

to this

aims to revolutionize

?

@mkaz

This comment has been minimized.

Copy link
Member Author

mkaz commented Jan 30, 2020

@jasmussen Be Danish. I adjusted the text 👍

@jasmussen

This comment has been minimized.

Copy link
Contributor

jasmussen commented Jan 30, 2020

Denmark underrepresent! The revolution will be careful!

@michelleweber

This comment has been minimized.

Copy link

michelleweber commented Jan 30, 2020

I fully support this injection of Danishness.

Copy link
Member

chrisvanpatten left a comment

Small nits but I think this is basically ready to go!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

chrisvanpatten left a comment

Looks great to me!

mkaz and others added 10 commits Jan 18, 2020
Update main project repository reamde with various updates that bring it
current for now and down the line.

First organized it into a more general getting started recognizing the
three levels that people might be coming to the project: as a User, as a
Devleoper, and as a Contributor

For User - added links to the user documentation, support forums, and
how to report an issue

For Develoepr - added links to the developer documentation

For Contributor - simplifed the contributor sections and links to the
contributors guide

I removed the links at the bottom since those are mostly dated from when
the project was starting out and justifying itself. These links can be
included elsewhere for background and context, and not necessary on the
welcoming page.
Thanks for the updates 👍

Co-Authored-By: Chris Van Patten <hello@chrisvanpatten.com>
@mkaz mkaz force-pushed the update/main-readme branch from 15361b6 to 3c669c7 Feb 10, 2020
@mkaz mkaz merged commit ad44389 into master Feb 10, 2020
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@mkaz mkaz deleted the update/main-readme branch Feb 10, 2020
@github-actions github-actions bot added this to the Gutenberg 7.5 milestone Feb 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

5 participants
You can’t perform that action at this time.