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

Docs: Update plugin sidebar to new how to guide template #37490

Merged
merged 3 commits into from
Dec 17, 2021
Merged

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Dec 17, 2021

Description

Updates the sidebar tutorial to a single page guide using the new how to template. This makes the guide easier to go through on a single page, cleans up block editor navigation reducing complexity in the navigation and moving the how to

Plus adds a new gutenberg-examples code. See this PR on gutenberg-examples repo: WordPress/gutenberg-examples#182

Closes #37343

How has this been tested?

Documentation changes, check for:

  • Clarity: content makes sense and accurate,
  • Mistakes: typos or speling issues,
  • Complete: Anything missing?

Types of changes

Documentation.

  • Combine pages down to single,
  • Remove old pages,
  • Update table of contents, links will be fine since they previously went to /docs/how-to-guides/plugin-sidebar/ already.
  • Small updates to simplify language and descriptions

Updates the sidebar tutorial to a single page guide using the new how
to template. This makes the guide easier to go through on a single page,
cleans up block editor navigation reducing complexity in the navigation
and moving the how to

Plus adds a new gutenberg-examples code.
@mkaz mkaz requested a review from ajitbohra as a code owner December 17, 2021 15:32
@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Dec 17, 2021
mkaz added a commit to WordPress/gutenberg-examples that referenced this pull request Dec 17, 2021
Copy link
Contributor

@ryanwelcher ryanwelcher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great tutorial! Just a few suggestions for clarity.

docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
docs/how-to-guides/plugin-sidebar.md Outdated Show resolved Hide resolved
@mkaz
Copy link
Member Author

mkaz commented Dec 17, 2021

Thanks @ryanwelcher for taking the time and going through and offering the suggestions! 🙇

@mkaz mkaz merged commit 24ed8ac into trunk Dec 17, 2021
@mkaz mkaz deleted the docs/37343-sidebar branch December 17, 2021 23:52
mkaz added a commit to WordPress/gutenberg-examples that referenced this pull request Dec 17, 2021
@github-actions github-actions bot added this to the Gutenberg 12.3 milestone Dec 17, 2021
mkaz added a commit that referenced this pull request Dec 18, 2021
An idiosyncracy of WP handbook publishing, there can't be a slug conflict,
the changes in #37490 used
the same slug due to the filename, which should of matched to the
directory.

This conflicted with the existing reference document here:
https://developer.wordpress.org/block-editor/reference-guides/slotfills/plugin-sidebar/

The published URL should actually be: /how-to-guides/plugin-sidebar-0/
which mapped to the old file instead of the directory.

You can confirm by not seeing the Plugin Sidebar in the navigation.
mkaz added a commit that referenced this pull request Dec 20, 2021
An idiosyncracy of WP handbook publishing, there can't be a slug conflict,
the changes in #37490 used
the same slug due to the filename, which should of matched to the
directory.

This conflicted with the existing reference document here:
https://developer.wordpress.org/block-editor/reference-guides/slotfills/plugin-sidebar/

The published URL should actually be: /how-to-guides/plugin-sidebar-0/
which mapped to the old file instead of the directory.

You can confirm by not seeing the Plugin Sidebar in the navigation.
goldentroll added a commit to goldentroll/gutenberg-examples that referenced this pull request Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Update Plugin Sidebar to a single page how to guide
2 participants