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: Addon-A11y - Documentation link to the docs for the test runner #25272

Merged
merged 2 commits into from
Dec 22, 2023

Conversation

Flambe
Copy link
Contributor

@Flambe Flambe commented Dec 19, 2023

What I did

We've had some issues where we were trying to skip some tests and didn't realise that the documentation for this addon is split up in multiple places. The readme does not currently tell you that the accessibility rules aren't checked at all when using the test runner.

I've added a link in the readme to the documentation describing how to integrate the story rules with the test runner instead of copying the instructions as it duplicating it all just creates more places that need updating if anything changes.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

  • stories
  • unit tests
  • integration tests
  • end-to-end tests

Manual testing

It's just a readme change, can't really test that afaik

Documentation

  • Add or update documentation reflecting your changes
  • If you are deprecating/removing a feature, make sure to update
    MIGRATION.MD

Checklist for Maintainers

  • When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli/src/sandbox-templates.ts

  • Make sure this PR contains one of the labels below:

    Available labels
    • bug: Internal changes that fixes incorrect behavior.
    • maintenance: User-facing maintenance tasks.
    • dependencies: Upgrading (sometimes downgrading) dependencies.
    • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
    • cleanup: Minor cleanup style change. Will not show up in release changelog.
    • documentation: Documentation only changes. Will not show up in release changelog.
    • feature request: Introducing a new feature.
    • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
    • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

@ndelangen ndelangen changed the title a11y: link to the docs for the test runner Addon-A11y: Documentation link to the docs for the test runner Dec 21, 2023
@ndelangen ndelangen added documentation addon: a11y ci:docs Run the CI jobs for documentation checks only. labels Dec 21, 2023
Copy link
Contributor

@jonniebigodes jonniebigodes left a comment

Choose a reason for hiding this comment

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

@Flambe, thanks for putting together this pull request and helping us improve the documentation. We appreciate it 🙏 ! So that you're aware, for this and other addons, the best documentation source is the official documentation and not the repo's Readmes, as they are a bit outdated and will be updated in the future to remove duplication, avoid the maintenance burden and keep a single source of truth. Until then, I am more than glad to merge this once the checklist clears and help you and other Storybook users get the required information they need.

Hope you have a fantastic holiday season.

Stay safe

@jonniebigodes jonniebigodes changed the title Addon-A11y: Documentation link to the docs for the test runner Docs: Addon-A11y - Documentation link to the docs for the test runner Dec 22, 2023
@jonniebigodes jonniebigodes merged commit a2c325e into storybookjs:next Dec 22, 2023
11 checks passed
@Flambe
Copy link
Contributor Author

Flambe commented Dec 24, 2023

Thank you for the info! I'll make sure the rest of the team is aware to use the main docs.

Have a great holiday as well!

@github-actions github-actions bot mentioned this pull request Dec 28, 2023
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: a11y ci:docs Run the CI jobs for documentation checks only. documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants