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: Gutenberg components - Updating examples #26367

Merged
merged 37 commits into from
Aug 23, 2018

Conversation

mmtr
Copy link
Member

@mmtr mmtr commented Jul 27, 2018

This continues #26314 and includes examples of the remaining Gutenberg components in the new "Gutenberg Components" section.

Examples are loaded dynamically from Gutenberg (WordPress/gutenberg#8267, WordPress/gutenberg#8338), so we don't need to maintain then anymore in Calypso.

Due to issues found, the new "Gutenberg Components" section is now behind the same feature flag we added in #26065, so it is only visible in a development environment.

Testing Instructions

With the devdocs/gutenberg-blocks feature flag enabled:

  • Start calypso in a development environment with npm start
  • Navigate to /devdocs/gutenberg-components
  • Examples of all the components should appear
  • Click in any component name
  • Documentation about the selected component should appear

With the devdocs/gutenberg-blocks feature flag disabled:

  • Start calypso in a development environment with DISABLE_FEATURES=devdocs/gutenberg-blocks npm start
  • Navigate to /devdocs
  • The sidebar item "Gutenberg components" does not appear in the "Live Docs" section
  • Navigate to /devdocs/gutenberg-components
  • "Page not found" error page is displayed

Issues

@mmtr mmtr added [Status] In Progress DevDocs [Goal] Gutenberg Working towards full integration with Gutenberg labels Jul 27, 2018
@matticbot
Copy link
Contributor

@mmtr
Copy link
Member Author

mmtr commented Aug 8, 2018

@gziolo let me know when the new version of the @wordpress/components package containing the updated REAMEDs is published, so this PR can be fully tested. thanks!

@gziolo
Copy link
Member

gziolo commented Aug 9, 2018

It will happen today, we were too busy preparing plugin's release yesterday :)

@mmtr mmtr force-pushed the update/devdocs-gutenberg-components branch from 768bf9d to 840e08f Compare August 9, 2018 18:06
@mmtr mmtr added the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Aug 9, 2018
@mmtr mmtr requested review from ehg, gziolo and gwwar August 9, 2018 18:10
@gziolo
Copy link
Member

gziolo commented Aug 9, 2018

I forgot to let you know but I see you already noticed that new version of packages was published 😎
Let us know how it integrates. We use new docs in Gutenberg handbook, pretty cool 👍

@mmtr mmtr force-pushed the update/devdocs-gutenberg-components branch from 840e08f to ed0783e Compare August 9, 2018 21:10
@mmtr mmtr force-pushed the update/devdocs-gutenberg-components branch 3 times, most recently from 4397dae to 5003c61 Compare August 14, 2018 20:02
mmtr added 24 commits August 23, 2018 19:40
Adding compatibility for components having a name that doesn't match the
file path
The section is now behind a feature flag
The section is now behind a feature flag
Adding section back to the Collection component
Added more context explaining how the examples are extracted
Amending class name
@mmtr mmtr force-pushed the update/devdocs-gutenberg-components branch from d73030b to 0d2b951 Compare August 23, 2018 17:41
@mmtr mmtr merged commit 9c012de into master Aug 23, 2018
@matticbot matticbot removed the [Status] Needs Review The PR is ready for review. This also triggers e2e canary tests and wp-desktop tests automatically. label Aug 23, 2018
@mmtr mmtr deleted the update/devdocs-gutenberg-components branch August 23, 2018 22:04
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants