Opened 6 years ago
Closed 6 years ago
#4388 closed enhancement (fixed)
Move Gutenberg Dev Handbook to DevHub
Reported by: |
|
Owned by: |
|
---|---|---|---|
Milestone: | Priority: | high | |
Component: | Developer Hub | Keywords: | |
Cc: |
Description
As a follow up to https://meta.trac.wordpress.org/ticket/4256
We've agreed with the Gutenberg team that the current Dev handbook at WordPress.org/gutenberg/handbook
needs to be moved to
https://developer.wordpress.org/block-editor/
The Gutenberg team would like the GitHub -> WordPress syndication intact.
So we're hoping for it to be moved to the appropriate spot with the handbook CPT created for the block editor.
I'm happy to create the CPT patch but not sure how we intent for the GitHub -> WordPress syndication to be setup
Change History (28)
This ticket was mentioned in Slack in #docs by kenshino. View the logs.
6 years ago
This ticket was mentioned in Slack in #meta-devhub by nosolosw. View the logs.
6 years ago
#13
@
6 years ago
For reference, we're working with the manifest in this PullRequest (not yet shipped in Gutenberg): https://github.com/WordPress/gutenberg/pull/15254/files
Wanted to have a more consolidated list of remaining tasks as per the Slack conversation in https://wordpress.slack.com/archives/C02RRH4GA/p1557247161057300
- https://developer.wordpress.org/block-editor/ shows the old README page. Contents should be https://github.com/WordPress/gutenberg/blob/master/docs/designers-developers/readme.md instead
- Sidebar page ordering is not reflective of the manifest.
- Some pages aren't fully up-to-date to the contents in the
master
branch. Some examples:- https://developer.wordpress.org/block-editor/designers/ VS https://github.com/WordPress/gutenberg/tree/master/docs/designers-developers/designers
- https://developer.wordpress.org/block-editor/tutorials/ VS https://github.com/WordPress/gutenberg/tree/master/docs/designers-developers/developers/tutorials
- Special characters are encoded in code examples, but shouldn't be. Example: https://developer.wordpress.org/block-editor/tutorials/block-tutorial/writing-your-first-block-type/
- The DevHub handbook pages have a table of contents (the box that floats to the right of pages that have subsections). These are disabled on /gutenberg,and would probably be best to be disabled on DevHub as well.
- As requested, I can disable syncing of the older /gutenberg/handbook handbook
- As requested, I can look into making the syncing paths relative
#22
@
6 years ago
- Keywords needs-patch 2nd-opinion removed
As of now, all of the tasks and issues from @nosolosw's comment have been addressed.
The current status was discussed in today's #docs team chat.
@chrisvanpatten wrote up a list of next steps:
- we'll get that branch merged so the manifest can come from
master
(@nosolosw / @chrisvanpatten)- handbook is rebuilt, and presumably goes live after a final sanity check, temporarily there are two handbooks
- redirects get enabled (@coffee2code)
- some indeterminate testing period just to make sure we're all happy, updates are successful, etc.
- handbook gets updated to point to
wp/{version}
branch
Everyone, please review the Block Editor handbook for any issues that remain.
I just have to (locally) test redirects from the legacy handbook. Once the manifest gets merged into master
and the green light is given, I'll update the handbook's manifest source and enable redirects, which should resolve this task.
#23
@
6 years ago
Tested the issues reported and reviewed randomly the DevHub's block editor. Everything looks fine. Let's ship this to users @coffee2code !
Note that there are two intermediate steps:
1.1. DevHub is updated to use the manifest-devhub.json in Gutenberg's master branch.
1.2. https://github.com/WordPress/gutenberg/pull/15254 can be deleted at this point.
#24
@
6 years ago
https://github.com/WordPress/gutenberg/pull/15254 has been merged into master
. It's now safe to proceed with step 1.1.
So I was told this by @rmccue