Skip to content

Docs: Fix ArgTypes links#25084

Merged
kylegach merged 2 commits into
nextfrom
docs_fix_vite_link
Dec 2, 2023
Merged

Docs: Fix ArgTypes links#25084
kylegach merged 2 commits into
nextfrom
docs_fix_vite_link

Conversation

@jonniebigodes
Copy link
Copy Markdown
Contributor

Addresses #22970

What I did

With this pull request, the ArgTypes links were updated to prevent them from 404ing in the documentation, whether viewing the source or, for instance, the pre-release version available. Originally reported here.

A simple test to verify this is to open the Vite builder pre-release documentation and click the link pointing to the ArgTypes documentation which will cause the 404. This can also be replicated by viewing the documentation in situ here on GitHub.

@kylegach I saw that you have a redirect in place, which helped out when the changes came online, but now is having a negative impact as the previous versions of the documentation are also 404ing (e.g., version 7.5, 7.4, etc). Can we mitigate this and set up something for those versions?

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

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

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>

@jonniebigodes jonniebigodes added documentation patch:yes Bugfix & documentation PR that need to be picked to main branch ci:docs Run the CI jobs for documentation checks only. labels Dec 1, 2023
@jonniebigodes jonniebigodes self-assigned this Dec 1, 2023
@kylegach
Copy link
Copy Markdown
Contributor

kylegach commented Dec 2, 2023

@kylegach I saw that you have a redirect in place, which helped out when the changes came online, but now is having a negative impact as the previous versions of the documentation are also 404ing (e.g., version 7.5, 7.4, etc). Can we mitigate this and set up something for those versions?

Thanks for letting me know. This should be addressed in storybookjs/frontpage#641

Copy link
Copy Markdown
Contributor

@kylegach kylegach left a comment

Choose a reason for hiding this comment

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

Thanks for taking care of this!

@kylegach kylegach merged commit 4a90af1 into next Dec 2, 2023
@kylegach kylegach deleted the docs_fix_vite_link branch December 2, 2023 02:41
@github-actions github-actions Bot mentioned this pull request Dec 2, 2023
36 tasks
storybook-bot pushed a commit that referenced this pull request Dec 2, 2023
@github-actions github-actions Bot mentioned this pull request Dec 2, 2023
11 tasks
storybook-bot pushed a commit that referenced this pull request Dec 4, 2023
storybook-bot pushed a commit that referenced this pull request Dec 4, 2023
storybook-bot pushed a commit that referenced this pull request Dec 4, 2023
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
storybook-bot pushed a commit that referenced this pull request Dec 5, 2023
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
storybook-bot pushed a commit that referenced this pull request Dec 6, 2023
@github-actions github-actions Bot mentioned this pull request Dec 7, 2023
44 tasks
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
storybook-bot pushed a commit that referenced this pull request Dec 7, 2023
@github-actions github-actions Bot added patch:done Patch/release PRs already cherry-picked to main/release branch labels Dec 7, 2023
@ndelangen ndelangen removed the patch:yes Bugfix & documentation PR that need to be picked to main branch label Oct 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci:docs Run the CI jobs for documentation checks only. documentation patch:done Patch/release PRs already cherry-picked to main/release branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants