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

Bug: Fix invalid docs links in Configure.mdx template page #28560

Merged
merged 2 commits into from
Jul 12, 2024

Conversation

kylegach
Copy link
Contributor

@kylegach kylegach commented Jul 12, 2024

What I did

  • Use query param instead of embedding renderer in URL
    • https://storybook.js.org/docs/{{renderer}}/configure/styling-and-csshttps://storybook.js.org/docs/configure/styling-and-css/?renderer={{renderer}}
  • Coerce vue3 to vue
    • The renderer value is only used for docs links and the docs site uses vue for both vue & vue3 renderers

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

  1. Run a sandbox for a vue3 template, e.g. yarn task --task sandbox --start-from auto --template vue3-vite/default-ts
  2. Open Storybook in your browser
  3. Navigate to the configure page
  4. Confirm all of the docs links work
    • The query param functionality is currently broken (in a hard-to-reproduce-consistently manner) on the site, so just confirm that the page isn't a 404 or other error. It may or may not also update your renderer to vue, if you were on a different one before.

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>

name before after diff %
createTime 17.9s 10.2s -7s -669ms 🔰-74.5%
generateTime 22.2s 21.7s -410ms -1.9%
initTime 22.6s 22.6s 19ms 0.1%
createSize 0 B 0 B 0 B -
generateSize 76.5 MB 76.5 MB 0 B 0%
initSize 198 MB 198 MB 172 B 0%
diffSize 122 MB 122 MB 172 B 0%
buildTime 12.9s 16s 3s 🔺19.2%
buildSize 7.59 MB 7.59 MB 84 B 0%
buildSbAddonsSize 1.63 MB 1.63 MB 0 B 0%
buildSbCommonSize 195 kB 195 kB 0 B 0%
buildSbManagerSize 2.3 MB 2.3 MB 0 B 0%
buildSbPreviewSize 349 kB 349 kB 0 B 0%
buildStaticSize 0 B 0 B 0 B -
buildPrebuildSize 4.47 MB 4.47 MB 0 B 0%
buildPreviewSize 3.12 MB 3.12 MB 84 B 0%
testBuildTime 0ms 0ms 0ms -
testBuildSize 0 B 0 B 0 B -
testBuildSbAddonsSize 0 B 0 B 0 B -
testBuildSbCommonSize 0 B 0 B 0 B -
testBuildSbManagerSize 0 B 0 B 0 B -
testBuildSbPreviewSize 0 B 0 B 0 B -
testBuildStaticSize 0 B 0 B 0 B -
testBuildPrebuildSize 0 B 0 B 0 B -
testBuildPreviewSize 0 B 0 B 0 B -
devPreviewResponsive 8.5s 9.2s 718ms 🔺7.8%
devManagerResponsive 5.7s 6.2s 499ms 🔺8%
devManagerHeaderVisible 806ms 893ms 87ms 🔺9.7%
devManagerIndexVisible 841ms 946ms 105ms 🔺11.1%
devStoryVisibleUncached 1.1s 1.3s 179ms 🔺13.1%
devStoryVisible 861ms 971ms 110ms 🔺11.3%
devAutodocsVisible 774ms 804ms 30ms 3.7%
devMDXVisible 770ms 808ms 38ms 4.7%
buildManagerHeaderVisible 762ms 839ms 77ms 🔺9.2%
buildManagerIndexVisible 765ms 840ms 75ms 🔺8.9%
buildStoryVisible 810ms 893ms 83ms 🔺9.3%
buildAutodocsVisible 698ms 702ms 4ms 0.6%
buildMDXVisible 698ms 707ms 9ms 1.3%

- Use query param instead of embedding renderer in URL
- Coerce `vue3` to `vue` (see code comment)
@kylegach kylegach added bug cli patch:yes Bugfix & documentation PR that need to be picked to main branch ci:normal labels Jul 12, 2024
@kylegach kylegach self-assigned this Jul 12, 2024
Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

PR Summary

  • Updated URLs in Configure.mdx files to use query parameters for the renderer
  • Coerced vue3 renderer value to vue for documentation links
  • Standardized documentation links to reduce the risk of broken links
  • Modified helpers.ts to align renderer type with documentation site usage

5 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings

Copy link

nx-cloud bot commented Jul 12, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f0731ef. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@kylegach kylegach merged commit 0c85715 into next Jul 12, 2024
52 of 53 checks passed
@kylegach kylegach deleted the fix-configure-page-links branch July 12, 2024 15:46
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
storybook-bot pushed a commit that referenced this pull request Jul 12, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
storybook-bot pushed a commit that referenced this pull request Jul 13, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
storybook-bot pushed a commit that referenced this pull request Jul 15, 2024
Bug: Fix invalid docs links in Configure.mdx template page
(cherry picked from commit 0c85715)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label Jul 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug ci:normal cli patch:done Patch/release PRs already cherry-picked to main/release branch patch:yes Bugfix & documentation PR that need to be picked to main branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants