[i18nIgnore] Fix pnpm command typos by mingjunlu · Pull Request #5284 · withastro/docs

mingjunlu · 2023-11-05T15:59:30Z

Description

I found that many package installation snippets use pnpm install <pkg> instead of pnpm add <pkg>.

According to pnpm's documentation:

pnpm install is used for installing all dependencies for a project
pnpm add <pkg> is used for installing certain new package(s)

This PR changes those to the latter ✍️

Related issues & labels

Suggested label: code snippet update

netlify · 2023-11-05T15:59:36Z

✅ Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`986b069`
🔍 Latest deploy log	https://app.netlify.com/sites/astro-docs-2/deploys/6547dc2426a9c60007d0d3a9
😎 Deploy Preview	https://deploy-preview-5284--astro-docs-2.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

astrobot-houston

Hello! Thank you for opening your first PR to Astro’s Docs! 🎉

Here’s what will happen next:

Our GitHub bots will run to check your changes.
If they spot any broken links you will see some error messages on this PR.
Don’t hesitate to ask any questions if you’re not sure what these mean!
In a few minutes, you’ll be able to see a preview of your changes on Netlify 🥳
One or more of our maintainers will take a look and may ask you to make changes.
We try to be responsive, but don’t worry if this takes a few days.

dreyfus92

You're right, there is a difference between pnpm install and pnpm add when using the pnpm package manager.

So in general:

Use pnpm install when setting up a brand new project, or when you want to fully reinstall all dependencies.
Use pnpm add when you just want to add a new dependency to an existing project.

The snippets likely use pnpm install because they are showing how to install a package in a generic, standalone way. But in the context of an existing project, pnpm add is preferrable for adding new packages.

Good catch on the distinction! Using the right command for the situation can save time and avoid unnecessary installs.

dreyfus92

Thank you for handling this @mingjunlu, I've left you a couple of suggestions let me know your thoughts.

dreyfus92 · 2023-11-05T17:33:20Z

src/content/docs/en/install/manual.mdx

  <Fragment slot="pnpm">
  ```shell
-  pnpm install astro 
+  pnpm add astro


I wouldn't replace install here, since this guide is about creating a brand new project.

Got it! Thanks for pointing it out 💡

dreyfus92 · 2023-11-05T17:35:07Z

src/content/docs/en/guides/images.mdx


 ```bash
-pnpm install sharp
+pnpm add sharp


I'm not completely sure about this one, i'd stick with a fresh re install of sharp tho.

No problem! Let's keep the original one

sarah11918 · 2023-11-05T18:15:09Z

Thanks so much @mingjunlu for helping us get the commands just right. And thank you for this excellent review, @dreyfus92 with extra context and for thoughtfully considering each individual change. Go Team! 🙌

I'm going to add the title keyword so that this PR touching multiple files doesn't affect our translation tracking status, and I'm going to apply the suggestions so this can be merged and helping people in docs right away!

@mingjunlu - If you find any error in the published version of this PR, please do make another one and let us know! I do agree with @dreyfus92 's assessment that in some cases, install is preferable, and will make those changes.

Thanks again, and welcome to Team Docs! 🥳

src/content/docs/en/guides/images.mdx

src/content/docs/en/install/manual.mdx

mingjunlu · 2023-11-06T02:50:15Z

Woah! To be honest, I didn't expect to receive response that fast! 🚀
@dreyfus92 @sarah11918 Thank you both for taking care of this PR and providing such valuable feedback. I'm glad that I could help 😊

Update translation with #5284 and #5363 L39 &78 Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>

…mdx` (#6363) * i18n(fr) Update reading-time.mdx Just for translator tracker because the PR #5766 should have been [ignore] * Update astro-pages.mdx * Update framework-components.mdx * Update layouts.mdx * Update routing.mdx * Update editor-setup.mdx * Update configuring-astro.mdx * Update cloudflare.mdx * Update deno.mdx * Update netlify.mdx * Update vercel.mdx * Update imports.mdx * Update auto.mdx * Update manual.mdx * Update cli-reference.mdx Update and del some parts * Update cli-reference.mdx Update fiule with PR #5512 #5651 #5604 #5765 #6040 #6043 #6109 #6267 * Update auto.mdx * Update cloudflare.mdx fix PR #5284 * Update markdown-content.mdx * Update auto.mdx * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/astro-pages.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/framework-components.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/core-concepts/framework-components.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/guides/markdown-content.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/install/manual.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/install/manual.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Update src/content/docs/fr/reference/cli-reference.mdx Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: Paul Valladares <85648028+dreyfus92@users.noreply.github.com>

Fix pnpm command typos

afde8a1

astrobot-houston reviewed Nov 5, 2023

View reviewed changes

mingjunlu changed the title ~~Fix pnpm code snippet typos~~ Fix pnpm command typos Nov 5, 2023

sarah11918 added help - confirm behaviour Walk through the example/issue and confirm this is a general behaviour, or a correct update to make. code snippet update Updates a code sample: typo, outdated code etc. labels Nov 5, 2023

dreyfus92 approved these changes Nov 5, 2023

View reviewed changes

dreyfus92 reviewed Nov 5, 2023

View reviewed changes

sarah11918 reviewed Nov 5, 2023

View reviewed changes

src/content/docs/en/guides/images.mdx Outdated Show resolved Hide resolved

sarah11918 reviewed Nov 5, 2023

View reviewed changes

src/content/docs/en/install/manual.mdx Outdated Show resolved Hide resolved

Apply suggestions from code review

986b069

sarah11918 changed the title ~~Fix pnpm command typos~~ [i18nIgnore] Fix pnpm command typos Nov 5, 2023

sarah11918 merged commit 0a62d07 into withastro:main Nov 5, 2023

mingjunlu deleted the fix/pnpm-command-typos branch November 6, 2023 02:50

This was referenced Nov 9, 2023

i18n(zh-cn): update tutorials/add-view-transitions.mdx #5317

Merged

i18n(zh-cn): update guides/cms/storyblok.mdx #5335

Merged

i18n(zh-cn): update editor-setup.mdx #5371

Merged

McFlyPartages mentioned this pull request Nov 12, 2023

i18n(fr) editor-setup.mdx #5372

Merged

yanthomasdev added a commit that referenced this pull request Nov 12, 2023

i18n(fr) editor-setup.mdx (#5372)

108c137

Update translation with #5284 and #5363 L39 &78 Co-authored-by: Yan Thomas <61414485+Yan-Thomas@users.noreply.github.com>

kimulaco mentioned this pull request Nov 25, 2023

i18n(ja): Update /editor-setup #5490

Merged

This was referenced Dec 5, 2023

i18n(ja): Update /guides/cms/buttercms.mdx #5608

Merged

i18n(ja): Update /guides/cms/contentful.mdx #5611

Merged

morinokami mentioned this pull request Dec 23, 2023

i18n(ja): Add new cloudflare.mdx translation #5109

Merged

McFlyPartages mentioned this pull request Jan 13, 2024

i18n(fr) Big Update for typescript.mdx #6372

Merged

Fryuni mentioned this pull request Feb 21, 2024

[i18nIgnore]: Fix pnpm command #6968

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

[i18nIgnore] Fix pnpm command typos#5284

[i18nIgnore] Fix pnpm command typos#5284
sarah11918 merged 2 commits intowithastro:mainfrom
mingjunlu:fix/pnpm-command-typos

mingjunlu commented Nov 5, 2023 •

edited

Loading

Uh oh!

netlify bot commented Nov 5, 2023 •

edited

Loading

Uh oh!

astrobot-houston left a comment

Uh oh!

dreyfus92 left a comment

Uh oh!

dreyfus92 left a comment

Uh oh!

dreyfus92 Nov 5, 2023 •

edited

Loading

Uh oh!

mingjunlu Nov 6, 2023

Uh oh!

dreyfus92 Nov 5, 2023

Uh oh!

mingjunlu Nov 6, 2023

Uh oh!

sarah11918 commented Nov 5, 2023

Uh oh!

Uh oh!

Uh oh!

mingjunlu commented Nov 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

mingjunlu commented Nov 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues & labels

Uh oh!

netlify bot commented Nov 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for astro-docs-2 ready!

Uh oh!

astrobot-houston left a comment

Choose a reason for hiding this comment

Uh oh!

dreyfus92 left a comment

Choose a reason for hiding this comment

Uh oh!

dreyfus92 left a comment

Choose a reason for hiding this comment

Uh oh!

dreyfus92 Nov 5, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mingjunlu Nov 6, 2023

Choose a reason for hiding this comment

Uh oh!

dreyfus92 Nov 5, 2023

Choose a reason for hiding this comment

Uh oh!

mingjunlu Nov 6, 2023

Choose a reason for hiding this comment

Uh oh!

sarah11918 commented Nov 5, 2023

Uh oh!

Uh oh!

Uh oh!

mingjunlu commented Nov 6, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

mingjunlu commented Nov 5, 2023 •

edited

Loading

netlify bot commented Nov 5, 2023 •

edited

Loading

dreyfus92 Nov 5, 2023 •

edited

Loading