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.

Sign up for GitHub

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

Jump to bottom

Introduce Storybook story about sidebar items without group #21189

Open
wants to merge 5 commits into
base: trunk
Choose a base branch
from
Open

Introduce Storybook story about sidebar items without group #21189

wants to merge 5 commits into from

Conversation

d-claassen
Copy link
Contributor

Context

  • We're investigating menus where the top level items are already navigation items, without a containing menu group. This story showcases how to implement such a solution.

Summary

This PR can be summarized in the following changelog entry:

  • [@yoast/ui-library] Adds story about implementing the Sidebar with menu items without a group.

Relevant technical choices:

  • Changed the way that functions are rendered in the code example to show their names.

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Start the local storybook with $ yarn workspace @yoast/ui-library storybook.
  • Check the new story about implementing the Sidebar with menu items without a group.
  • Check stories for Modal, FileImport and AutocompleteField to see other functions rendered in the code blocks.

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

QA can test this PR by following these steps:

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

  • None.

UI changes

  • This PR changes the UI in the plugin. I have added the 'UI change' label to this PR.

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #

@d-claassen d-claassen added the changelog: other Needs to be included in the 'Other' category in the changelog label Mar 1, 2024
@d-claassen d-claassen requested a review from a team as a code owner March 1, 2024 15:21
@d-claassen d-claassen force-pushed the d-claassen/sidebar-top-level-items branch 2 times, most recently from 13c6ad9 to f32fb39 Compare March 1, 2024 15:42
@coveralls
Copy link

coveralls commented Mar 1, 2024 •
edited
Loading

Pull Request Test Coverage Report for Build d1cf58fed672f98668c8c05527af9ff01501a931

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 53.319%
Totals Coverage Status
Change from base Build 28f4040474edccb2fc10277c33602b5e21ff859b: 0.0%
Covered Lines: 29160
Relevant Lines: 55013
💛 - Coveralls

@d-claassen d-claassen force-pushed the d-claassen/sidebar-top-level-items branch 3 times, most recently from b6a8c13 to e72b629 Compare March 4, 2024 15:05
@d-claassen d-claassen force-pushed the d-claassen/sidebar-top-level-items branch from e72b629 to 3fba4b4 Compare March 5, 2024 14:03
@d-claassen
Copy link
Contributor Author

Resolved by #21652. Suppose we can just close this.

@github-actions GitHub Actions
Copy link

A merge conflict has been detected for the proposed code changes in this PR. Please resolve the conflict by either rebasing the PR or merging in changes from the base branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
changelog: other Needs to be included in the 'Other' category in the changelog merge conflict
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@d-claassen @coveralls