Gutenberg Dev Docs: Call for Contributions

With the release of WordPress 5.0 and the new Gutenberg block editor, there are many changes in WordPress for users and developers alike.

For developers in particular, the changes are dramatic. As such, we also have a lot of new documentation to create: and we need your help!

If you’re a developer and have spent time working with Gutenberg, this is your time to shine. We’re looking for contributions in a few specific areas.

Examples

Most of the requests we get are “how do I do X?”, so we are looking for code examples and “micro-tutorials” that can help developers solve these questions and integrate with Gutenberg.

Contributions here are ideally in the form of a single markdown file, with at least a few hundred words that describe the problem and walk users through the solution, with complete code examples. They should link out to the relevant API documentation (where it exists) or to other areas of the handbook that offer further context.

A few ideas for contributions include…

  • How to register a sidebar plugin
  • How you might use InnerBlocks
  • How you could port a custom metabox to a custom sidebar plugin
  • How to trigger a modal
  • How to write block attributes to post_meta
  • How to use the color HOCs and components in your blocks
  • How to filter specific areas of the editor (especially panels in the document settings sidebar)
  • How to filter the available blocks in the editor
  • How to use the data module to retrieve post data within a custom component

Package documentation

Gutenberg is built with a collection of npm packages. Some of these packages have great documentation in their READMEs, but others don’t. This is another great way to contribute: choose a package, and improve the README in a pull request on the GitHub repo.

Each README should include:

  1. Installation instructions (most have this already!)
  2. General/basic usage instructions
  3. Function documentation, if applicable
  4. Links to other documentation that might be relevant/helpful

Component documentation

The new editor also leverages Components to build the user interface. These are provided inside the @wordpress/components package. Each component should have its own README that contains:

  1. Basic usage example
  2. “Dos and Don’ts” of how to use the component correctly (from a UX perspective)
  3. Attribute documentation

This GitHub gist is a template that you can use as the basis for your own component documentation.

Other options

Although these are our highest priority items, they are by no means the only ways you can contribute. The “Documentation” label on GitHub offers many more ideas. Picking a ticket and writing the documentation to solve the issue is a great way to contribute.

We’re all committed to making Gutenberg documentation the best on the web. Thanks so much for your interest, and we hope you’ll also consider joining our weekly meeting in #docs in Slack at 18:00 UTC!

Agenda for Docs Team Meeting 10 December 2018

The next Documentation Team meeting is scheduled on

Monday, December 10, 2018, 15:00 UTC

in the #docs channel on Slack.

It is right after WCUS so it’s likely we won’t get much attendance. If that happens we’ll have a short meeting and look forward to a bigger update the next one.

Current Projects Updates:

  1. Codex Migration (DevHub) – @atachibana
  2. DevHub – @drewapicture & @coffee2code
  3. HelpHub – @kenshino
  4. Inline Docs – @drewapicture & @atimmer
  5. Gutenberg Handbook – @chrisvanpatten

Open Floor

Feel free to comment if you have items to add to the agenda.

Agenda for Gutenberg docs meeting 27 November 2018

Hello all,

Looking forward to another Gutenberg docs meeting today!

Tuesday, November 27, 2018, 18:00 UTC

Today’s meeting is in #docs in Slack.

Agenda

  1. Attendance
  2. Status update
    1. User docs coordination
    2. Dev docs coordination
  3. Open floor

Hope to see you in #docs!

Agenda for Docs Team meeting 26 November 2018

The next Documentation Team meeting is scheduled on

Monday, November 26, 2018, 15:00 UTC

in the #docs channel on Slack.

If we do not get any attendance, open floor will be held instead

Current Projects Updates:

  1. Codex Migration (DevHub) – @atachibana
  2. DevHub – @drewapicture & @coffee2code
  3. HelpHub – @kenshino
  4. Inline Docs – @drewapicture & @atimmer
  5. Gutenberg Handbook – @chrisvanpatten

Open Floor

Feel free to comment if you have items to add to the agenda.

Summary of HelpHub meeting 19 November 2018

Attendance

@kenshino @jessecowens @atachibana @mehul0810 @softservenet @sergey @milana_cap @howdy_mcgee and @mapk

Phase 1 launch discussion

All pages were migrated into production site from stagin and published.
We are doing a readiness check such as missing links, wrong images and garbled codes. Anyone can join this release check from below spreadsheet:
https://docs.google.com/spreadsheets/d/1PeHj7pSFLcdMbIC41JJdzEkl12TJT3mwWyzQv2mi01U/edit#gid=835534324
We have all the code commits in and the articles look fine thanks to @netweb 🙂

Phase 2 discussions

when the Phase 1 is done, we are moving focus on Phase 2

  • continuing migration from Codex (led by @atachibana)
  • development of features/functionality labelled as Phase 2 (led by @milana_cap)
    https://github.com/Kenshino/HelpHub/issues?q=is%3Aissue+is%3Aopen+label%3A%22Phase+2%22

We have a document of available developers. if you want to be added to the list, ping @milana_cap (or @zzap in Slack).
https://docs.google.com/spreadsheets/d/1hAPORz_yl4UTerPo8Tl5j_Xznfpm_NItrNftoXwBqvA/edit?usp=sharing

Priorities.
@kenshino and @milana_cap will set Phase 2 milestone 1. (e.g. Version Pages, blocks and templates, user feedback / contribution …)
@mapk will give some idea to map content to blocks, based on which we will create blocks template. See https://github.com/Kenshino/HelpHub/issues/245

Summary of Docs Team meeting 12 November 2018

Attendance

@atachibana @softservenet @jessecowens and @howdy_mcgee

Codex Migration (DevHub)

This project is migration of development articles from Codex to DevHub, or Developer Resources (https://developer.wordpress.org/) e.g. Function reference.

Now we are concentrating to HelpHub, or User documents migration. We will re-start the project after the HelpHub release.

Gutenberg Handbook

During previous Gutenberg Docs meeting, @chrisvanpatten mentioned the user documents of Gutenberg. We would like to co-work with him and enhanced the HelpHub contents.

Agenda for HelpHub meeting 19 November 2018

Hello all,

Next HelpHub meeting will happen on

Monday, November 19, 2018, 15:00 UTC

We’ve had a fair bit of movement for Phase 1 so do join in as we discuss launch dates and steps

  1. Attendance
  2. Phase 1 Launch
  3. Phase 2 discussion
  4. Bug Scrub
  5. AOB

Helpful Links

  • HelpHub Staging – https://wp-helphub.com/
  • GitHub repo – https://github.com/kenshino/helphub
  • State of HelpHub (read for Phase 2) – https://make.wordpress.org/docs/2018/02/26/state-of-helphub-february-2018/

Agenda for Gutenberg docs meeting 13 November 2018

Hello all,

Looking forward to another Gutenberg docs meeting today!

Tuesday, November 13, 2018, 17:00 UTC

Today’s meeting is in #docs in Slack.

Agenda

  1. Attendance
  2. Status update/call for help: documentation PR
  3. Bug scrub
  4. Open floor

Hope to see you in #docs!

Agenda for Docs Team meeting 12 November 2018

The next Documentation Team meeting is scheduled on

Monday, November 12, 2018, 15:00 UTC

in the #docs channel on Slack.

If we do not get any attendance, open floor will be held instead

Current Projects Updates:

  1. Codex Migration (DevHub) – @atachibana
  2. DevHub – @drewapicture & @coffee2code
  3. HelpHub – @kenshino
  4. Inline Docs – @drewapicture & @atimmer
  5. Gutenberg Handbook – @chrisvanpatten

Open Floor

Feel free to comment if you have items to add to the agenda.

Summary for HelpHub Meeting 5 November 2018

Below is a summary of last week’s meeting.

Attendance

@milana_cap @wizzard_ @poena @yuli-yang @felipeelia @atachibana

Phase 1 Updates

@kenshino posted Call for Volunteers, and so many new contrbutors helped us to migrate staging site to production.
Contributors: @akhrayaprolu @softservenet @malice1332 @mehul0810 @howdy_mcgee @jessecowens @pskli @william68 @yuli-yang @poena

Stats:

  • Done 80 (69.6%)
  • In Progress 9 (7.8%)
  • Remains 26 (22.6%)
  • Total 115

For more details, refer this spreadsheet.

We are editing those contents with Gutenberg (of course :-)) and will report some difficultlies and issues that we found to https://github.com/WordPress/gutenberg.

Phase 2 discussion

Phase 2 work will start after migration for Phase 1 is over as that is priority. Phase 2 issues are here. If you want to join this project, please contact to @milana_cap.

AOB

@netweb and @clorith are working hard to setup production site for HelpHub. Thank you!