Opened 5 years ago

Closed 5 years ago

Last modified 4 years ago

#4244 closed defect (bug) (fixed)

Change the base branch used to synchronize the Gutenberg handbook

Reported by: youknowriad's profile youknowriad Owned by: coffee2code's profile coffee2code
Milestone: Priority: normal
Component: Handbooks Keywords:


The idea is that the handbook should follow the stable version of WordPress. Ideally, we'd have at least two versions of the handbook, one for the stable version and another one for the Gutenberg plugin. We could also imagine a version selector but for now, let's fix the most urgent.

I'm new to the meta repo and trac, I'm not sure how to test this patch. Anyway, let me know if I did anything wrong.

Attachments (1)

change-gutenberg-handbook-branch.diff (871 bytes) - added by youknowriad 5 years ago.

Download all attachments as: .zip

Change History (9)

#1 @dd32
5 years ago

change-gutenberg-handbook-branch.diff looks like the first steps, however is going to get old having to update that branch reference..

Additionally, the manifest itself links to master still, so updating this won't actually change anything AFAIK.

#2 follow-up: @youknowriad
5 years ago

Mmm right, I guess the manifest should be updated to use relative links instead. I created an issue about it I'll circle back here once it's done.

#3 in reply to: ↑ 2 @dd32
5 years ago

Replying to youknowriad:

Mmm right, I guess the manifest should be updated to use relative links instead. I created an issue about it I'll circle back here once it's done.

Sure, that'll work, make sure you circle back and get support for that added to the parser before it's in master though :)
Bit hard to test until there's at least a PR to test against.

This ticket was mentioned in Slack in #meta by tellyworth. View the logs.

5 years ago

#5 @tellyworth
5 years ago

  • Owner set to coffee2code
  • Status changed from new to assigned

As per Slack, it seems like @coffee2code might handle this as part of migrating the Blocks handbook to

#6 @coffee2code
5 years ago

  • Resolution set to fixed
  • Status changed from assigned to closed

In 8776:

Markdown Importer: Support relative paths for per-page markdown source.

The markdown_source values defined in manifests can continue to be fully qualified URLs, but now they can alternatively also be paths relative to the URL path for the manifest file. Parent path notation can be used (e.g. "../"), but attempts to refer to higher level paths (e.g. "../../") will not be honored beyond the parent.

Fixes #4244.
See #4388.

#7 @coffee2code
5 years ago

  • Component changed from General to Handbooks

As per #4388 and (and some recent discussions in #meta-devhub on Slack), the Gutenberg handbook is being migrated to DevHub (it's just being finalized now).

The handbook importer as used on DevHub now supports relative paths, and the manifest used for the Block Editor handbook there makes use of relative paths.

Since the legacy handbook at is being deprecated and eventually redirected, the importer for the site (which is a customized implementation) was not updated to support relative paths (and, in fact, has been disabled in [8775]).


#8 @youknowriad
4 years ago

Coming here after this issue was created in Gutenberg.

I'm wondering if we should reopen this ticket and update the branch used to sync the Gutenberg handbook. We should rely on the wp/5.3 branch instead of master otherwise we may leak APIs that are not in Core yet.

Ideally, we'd have a version selector.

Note: See TracTickets for help on using tickets.