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: Correct command in examples of adding packages with pnpm #26998

Merged
merged 2 commits into from
May 2, 2024
Merged

Docs: Correct command in examples of adding packages with pnpm #26998

merged 2 commits into from
May 2, 2024

Conversation

scottdotweb
Copy link
Contributor

@scottdotweb scottdotweb commented May 1, 2024

What I did

Changed instances in the docs of pnpm install to pnpm add, which is the correct command to use when adding packages with pnpm.

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!

No manual test required.

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>

@scottdotweb scottdotweb changed the title Correct command in examples of adding packages with pnpm Docs: Correct command in examples of adding packages with pnpm May 1, 2024
Copy link

nx-cloud bot commented May 1, 2024

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 16c7e42. 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.

@jonniebigodes jonniebigodes self-assigned this May 1, 2024
@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 May 1, 2024
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.

@scottdotjs, thanks for putting together this pull request and helping us improve the documentation by catching these minor but important typos in the examples. We appreciate it 🙏 !

I've checked, and everything is good on my end. I'll merge this once the checklist clears.

Hope you have a fantastic day.

Stay safe

@jonniebigodes jonniebigodes merged commit 56a9f7b into storybookjs:next May 2, 2024
10 checks passed
storybook-bot pushed a commit that referenced this pull request May 2, 2024
Docs: Correct command in examples of adding packages with pnpm
(cherry picked from commit 56a9f7b)
@github-actions github-actions bot mentioned this pull request May 2, 2024
9 tasks
storybook-bot pushed a commit that referenced this pull request May 3, 2024
Docs: Correct command in examples of adding packages with pnpm
(cherry picked from commit 56a9f7b)
@github-actions github-actions bot mentioned this pull request May 3, 2024
44 tasks
storybook-bot pushed a commit that referenced this pull request May 4, 2024
Docs: Correct command in examples of adding packages with pnpm
(cherry picked from commit 56a9f7b)
storybook-bot pushed a commit that referenced this pull request May 4, 2024
Docs: Correct command in examples of adding packages with pnpm
(cherry picked from commit 56a9f7b)
storybook-bot pushed a commit that referenced this pull request May 5, 2024
Docs: Correct command in examples of adding packages with pnpm
(cherry picked from commit 56a9f7b)
@github-actions github-actions bot added the patch:done Patch/release PRs already cherry-picked to main/release branch label May 5, 2024
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 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.

2 participants