Correct the docs manifest #12411
Merged
Correct the docs manifest #12411
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…Importer can't handle that.
… altered slightly from WordPress@a0a6349
dd32
force-pushed
the
fix/docs-parsing
branch
from
0570a49 to
7dddeab
Compare
|
Oh @dd32 you are my hero. I’ll review this today! |
chrisvanpatten
approved these changes
Nov 29, 2018
|
This all makes sense and obviously based on the live handbook it works really well! It's not clear yet if we will end up adding the I'm happy to help with the cleanup on .org but I don't have access there right now. In the future, if I expect a docs change to cause problems on import (moving an item between children, renaming something, etc.) should I just mention you, or ask for access myself? |
|
Restarted Travis… it's an e2e failure so totally unrelated to these changes. |
daniloercoli
added a commit
that referenced
this pull request
Nov 30, 2018
…rnmobile/danilo-try-to-fix-undo-redo * 'master' of https://github.com/WordPress/gutenberg: Autocompleters: Consider block category (#12287) Only init TinyMCE once per instance (#12386) RichText: convert HTML formatting whitespace to spaces (#12166) Notices: Remove "files" block in package.json (#12438) Edit Post: Avoid rendering AdminNotices compatibility component (#12444) Correct the docs manifest (#12411)
daniloercoli
added a commit
that referenced
this pull request
Nov 30, 2018
…HEAD * 'master' of https://github.com/WordPress/gutenberg: [RNmobile] Fix problems with undo/redo on Android (#12417) Add registry param to withDispatch component (#11851) Autocompleters: Consider block category (#12287) Only init TinyMCE once per instance (#12386) RichText: convert HTML formatting whitespace to spaces (#12166) Notices: Remove "files" block in package.json (#12438) Edit Post: Avoid rendering AdminNotices compatibility component (#12444) Correct the docs manifest (#12411)
ntwb
pushed a commit
that referenced
this pull request
Dec 4, 2018
## Description Following on from #12411 and #11817 it was noticed that some pages were skipped, as they weren't included in the `toc.json` file previously. This PR includes several specific fixes which are all interconnected: 1. Adds the Internationalization page along with the Block Tutorial to the handbook hierarchy 1. An additional landing page for the Tutorials index was added 1. `Components` was added to the developers handbook alongside `Packages` and `Data Package Reference` pages. 1. In order to handle the above move, the duplicative declarations of `Packages`, `Data Package Reference` and `Components` were removed from `docs/tool/manifest.js` to prevent them adding as top-level-items. (Are these intended to be top-level-handbook-pages or deep within the developers handbook as the TOC seems to suggest?) I also took the opportunity to convert `generate.php` from the previous PR into a JS command that allows for `docs/root-manifest.json` to be removed entirely and dynamically generated from `docs/toc.json` so it only needs updating in a single location. That's the `getRootManifest()` and `generateRootManifestFromTOCItems()` functions which are rather messy, but work (I'm sure someone else could clean that up significantly). ## How has this been tested? The only testing done so far is the manual review of the final `docs/manifest.json`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
As mentioned in #meta following #11817 the handbook import process failed to pick up the changed files, and resulted in a number of orphaned items.
The cause of this is several fold:
parentfield, where the importer only supports a singular slug (ie.developersnotdesigners-developers/developers)slugfields for root-level pagestoc.jsonfile which was used to generate theroot-manifest.jsondidn't have thecontributorsorusershandbook added to it, and as a resultroot-manifest.jsonwas never updated either (I couldn't find a tool which does this automatically, See 700e159 for the script I borrowed from Reorganise documentation #11817 and modified).Known Bugs
(Some of these are not bugs or should be individual issues/bugs/PRs, I'm noting it here though)
Usershandbook wasn't added to the TOC as nothing exists within it. The Gutenberg handbook landing page links to it though. Once content is added it'll need to be added totoc.jsonandroot-manifest.json.Contributorshandbook index page has no text, and so is now blank.$slug-2url, etc.How has this been tested?
It was used to import the docs onto https://wordpress.org/gutenberg/handbook/