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

DevDocs: show Gutenberg blocks #26064

Closed
9 tasks
mmtr opened this issue Jul 14, 2018 · 1 comment
Closed
9 tasks

DevDocs: show Gutenberg blocks #26064

mmtr opened this issue Jul 14, 2018 · 1 comment
Assignees
Labels
DevDocs [Goal] Gutenberg Working towards full integration with Gutenberg [Type] Task

Comments

@mmtr
Copy link
Member

mmtr commented Jul 14, 2018

Background

As part of the current plan for integrating Gutenberg into Calypso, it would be nice to include the Gutenberg blocks in Calypso and reflect the developer documentation with these new reusable pieces of UI.

Goals

  • 🔨 Include the Gutenberg built-in blocks in Calypso. This depends on other work currently being developed in order to expose publicly the different Gutenberg modules as independent npm packages (Packages: Publish all modules as independent npm packages WordPress/gutenberg#3955).
  • 📘 Update the developer documentation in Calypso, so we let folks know how the Gutenberg blocks can be used for building the Calypso’s UI.
  • 📣 Provide feedback to the Gutenberg project, so potential blockers can be identified when using the Gutenberg blocks in other projects.

Tasks

  • Include a new section in the developer documentation that will be used in the future for adding the documentation explaining how to use the Gutenberg blocks in Calypso (DevDocs: add a Gutenberg blocks section #26065)
  • Identify potential blockers we can have with the @wordpress/core-blocks npm package, using the @wordpress/components package (Proof of concept: render a Gutenberg component in Calypso DevDocs #26088)
  • Prototype what a single Gutenberg block should look like in the new section on an experimental branch, copying over files if we really need to.
  • Update the Components page explaining what Gutenberg blocks are
  • Update the new Gutenberg blocks section with the collection of blocks exposed by the @wordpress/core-blocks npm package
  • Include individual documentation for each Gutenberg block
  • Add a search bar in the new Gutenberg blocks section so they can be filtered
  • Integrate the Gutenberg blocks in the Playground section
  • Remove feature flag
@mmtr mmtr added [Type] Task [Goal] Gutenberg Working towards full integration with Gutenberg labels Jul 14, 2018
@mmtr mmtr self-assigned this Jul 14, 2018
@mmtr mmtr added the DevDocs label Jul 14, 2018
@mmtr mmtr changed the title Devdocs: add a Gutenberg blocks section DevDocs: add a Gutenberg blocks section Jul 14, 2018
@mmtr mmtr changed the title DevDocs: add a Gutenberg blocks section DevDocs: show Gutenberg blocks Jul 16, 2018
@mmtr
Copy link
Member Author

mmtr commented Jul 17, 2018

I have created a project that makes this issue useless as it was intended for splitting the project in small tasks and check the progress

@mmtr mmtr closed this as completed Jul 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DevDocs [Goal] Gutenberg Working towards full integration with Gutenberg [Type] Task
Projects
None yet
Development

No branches or pull requests

1 participant