Docs: tweak organization for getting-started docs #34091
Merged
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
|
🤔 Is it a problem with nesting? One of the child pages that is even more nested shows up correctly:
How can we test this with the sidebar on WP.org? (Maybe we can cc folks who can test it?) |
|
@gwwar Nesting is not necessarily the problem with it showing up in the sidebar, but it not showing up highlighted to me that we are needlessly nesting two sections. The tutorials section that is there only contains the two getting started tutorials with the rest of them in the "How to Guides" section. So having an extra nesting for Tutorials is not really necessarily and makes sense to just move them up to "getting-started" I believe they are not showing up due to the way it is trying to match pages to items in the sidebar. The sidebar is created by the Handbook widget here. My thought is to clean up the organization of the files, and then troubleshoot with the items in their proper place. |
mkaz
force-pushed
the
docs/unnest-tutorials
branch
from
16b8c78 to
2d96b04
Compare
|
We will have also to update occurrences in the codebase like here: |
mkaz
force-pushed
the
docs/unnest-tutorials
branch
from
009247c to
22d2bca
Compare
|
Thanks @gziolo - I had searched the repo but somehow missed a few links. Updated 👍 There were several links already broken to other areas not even changed here, I fixed those up too. 😁 |
|
Size Change: 0 B Total Size: 1.07 MB ℹ️ View Unchanged
|
20 tasks
mkaz
force-pushed
the
docs/unnest-tutorials
branch
from
22d2bca to
c47184d
Compare
|
NOTE: I added the TRAC ticket with redirects here: https://meta.trac.wordpress.org/ticket/5912 Once approved, we'll want to coordinate the merge of this ticket with the redirects. |
mkaz
force-pushed
the
docs/unnest-tutorials
branch
from
d64e983 to
98182d7
Compare
|
@gziolo I rebased and I think this is ready. |
Issue #33429 highlighted an issue with too many nesting levels of the tutorials, they do not show properly in the sidebar. This PR will start to address, by removing the tutorials layer and moving the two getting started guides up a level. - Remove a nesting level for getting-started - Move FAQ, Glossary, and History to explanations section, they add a bit of noise to the getting started section and fit well in explanations since the content is more historical reference for the project
The publishing uses the title of the page to be the slug in WordPress and having the main page and the getting-started section have the same name is causing issues. This is forcing all the content in /getting-started/ to be prefixed with /handbook/ which is not a directory in the documentation.
mkaz
force-pushed
the
docs/unnest-tutorials
branch
from
98182d7 to
6c03741
Compare
gziolo
approved these changes
Oct 22, 2021
bazza
pushed a commit
to WordPress/wordpress.org
that referenced
this pull request
Oct 22, 2021
Props mkaz. Fixes #5912. See WordPress/gutenberg#34091 git-svn-id: https://meta.svn.wordpress.org/sites/trunk@11293 74240141-8908-4e6f-9713-ba540dce6ec7
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
Issue #33429 highlighted an issue with too many nesting levels of the
tutorials, they do not show properly in the sidebar.
This PR will start to address, by removing the tutorials layer and
moving the two getting started guides up a level.
Remove a nesting level for getting-started
Move FAQ, Glossary, and History to explanations section, they add a
bit of noise to the getting started section and fit well in
explanations since the content is more historical reference for the
project
Fix link references to new locations across the docs
How has this been tested?
Documentation - confirm updates make sense and links are correct.
Types of changes
Documentation.
NOTE:
TRAC Ticket with redirects: https://meta.trac.wordpress.org/ticket/5912