Skip to content

UI library: Dupp 753 document other exports in storybook 2#19384

Merged
nolledgeable merged 4 commits intofeature/ui-library-3from
DUPP-753-document-other-exports-in-Storybook-2
Dec 13, 2022
Merged

UI library: Dupp 753 document other exports in storybook 2#19384
nolledgeable merged 4 commits intofeature/ui-library-3from
DUPP-753-document-other-exports-in-Storybook-2

Conversation

@nolledgeable
Copy link
Copy Markdown
Contributor

This PR is a cleaned up copy of #19369

Context

  • Add documentation for the hooks.

Summary

This PR can be summarized in the following changelog entry:

  • Add documentation for the hooks.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Open story book and look in the end of the menu for Other exports/Hooks. Check if the documentation are clear to understand and are true to the hooks functionality.

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 (Block/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:

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.

Quality assurance

  • I have tested this code to the best of my abilities
  • 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.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label and noted the work hours.

Fixes DUPP-753

@nolledgeable nolledgeable changed the base branch from trunk to feature/ui-library-3 December 13, 2022 14:32
@nolledgeable nolledgeable added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Dec 13, 2022
@nolledgeable nolledgeable modified the milestones: ui lib, ui-library Dec 13, 2022
@nolledgeable nolledgeable merged commit 0ba41d2 into feature/ui-library-3 Dec 13, 2022
@nolledgeable nolledgeable deleted the DUPP-753-document-other-exports-in-Storybook-2 branch December 13, 2022 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants