[i18nIgnore] docs: `pnpm install` → `pnpm add` #1324

HiDeoo · 2024-01-02T10:53:23Z

What kind of changes does this PR include?

Changes or translations of Starlight docs site content

Description

As discussed in the last Talking and Doc'ing session, it seems that even tho pnpm install <pkg> works and do the expected job, it might be better to align with the pnpm docs and use pnpm add <pkg> instead:

pnpm install is used to install all dependencies for a project (reference)
pnpm add <pkg> installs a package and any packages that it depends on (reference)

This PR updates the docs to use pnpm add instead of pnpm install when installing a specific package.

If there are any reasons to keep pnpm install for reasons that none of the session attendees thought of, we can close this PR altho we might want to notify the docs team so they are aware of it before continuing the same process (https://github.com/withastro/docs/pull/5978/files already includes this changes).

changeset-bot · 2024-01-02T10:53:27Z

⚠️ No Changeset found

Latest commit: cf0ca75

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

vercel · 2024-01-02T10:53:27Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
starlight	✅ Ready (Inspect)	Visit Preview	Jan 15, 2024 9:46am

1 Ignored Deployment

Name	Status	Preview	Updated (UTC)
starlight-i18n	⬜️ Ignored (Inspect)	Visit Preview	Jan 15, 2024 9:46am

at-the-vr

LGTM, thanks for the PR. I do recall this was discussed on last week Talking and Doc'ing

ElianCodes

Good catch! Thanks Hideoo!

kevinzunigacuellar

pnpm add this PR!

delucis

This looks good to me!

@HiDeoo any thoughts on doing this across languages and adding an [i18nIgnore]? Feels like the kind of change that would be safe to do that way and avoid marking more stuff out of date than necessary.

dreyfus92

LGTM ✅

HiDeoo · 2024-01-13T12:03:26Z

@HiDeoo any thoughts on doing this across languages and adding an [i18nIgnore]? Feels like the kind of change that would be safe to do that way and avoid marking more stuff out of date than necessary.

Sorry for the late reply. This is a great idea, I don't quite remember if I did not think about it or if I wanted to get an approval before doing it but no matter what, I'll update the branch, update all locales and add the [i18nIgnore] tag in the next few days.

* main: (55 commits) [ci] format i18n(es): Update `index` (withastro#1360) [ci] format i18n(fr): Update index (withastro#1367) i18n(es): remove extra section (withastro#1370) i18n(ko-KR): update `index.mdx` (withastro#1363) [ci] format i18n(zh-cn): Update index.mdx (withastro#1361) docs(showcase): add OpenSaaS.sh (withastro#1359) feat(Testimonials): add testimonials to website (withastro#1104) [ci] format [ci] release (withastro#1332) fix: autogenerated sidebar alphabetical sort (withastro#1298) Avoid sidebar scrollbar hiding behind navbar (withastro#1353) Use spawnSync instead of execaSync in `git.ts` (withastro#1347) [ci] format [i18nIgnore] Add src alias (withastro#1322) Italian translation for search.devWarning (withastro#1351) [ci] format i18n(pt-BR): Add translation for `guides/sidebar` (withastro#1346) ...

HiDeoo · 2024-01-15T09:48:49Z

Just pushed a new commit applying the changes to all languages and added the [i18nIgnore] tag to the PR title, we should be good for a final review.

There is now only 1 reference to pnpm install in the docs/ folder which is in the docs/README.md file:

$ rg 'pnpm install'
README.md
16:| `pnpm install`          | Installs dependencies                            |

delucis

Thank you @HiDeoo! This looks good to me. Time to pnpm add this PR to the docs 🚀

* main: (69 commits) [i18nIgnore] docs: `pnpm install` → `pnpm add` (withastro#1324) [ci] format i18n(zh-cn): Update frontmatter.mdx (withastro#1362) [ci] format i18n(es): Update `index` (withastro#1360) [ci] format i18n(fr): Update index (withastro#1367) i18n(es): remove extra section (withastro#1370) i18n(ko-KR): update `index.mdx` (withastro#1363) [ci] format i18n(zh-cn): Update index.mdx (withastro#1361) docs(showcase): add OpenSaaS.sh (withastro#1359) feat(Testimonials): add testimonials to website (withastro#1104) [ci] format [ci] release (withastro#1332) fix: autogenerated sidebar alphabetical sort (withastro#1298) Avoid sidebar scrollbar hiding behind navbar (withastro#1353) Use spawnSync instead of execaSync in `git.ts` (withastro#1347) [ci] format [i18nIgnore] Add src alias (withastro#1322) ...

* main: (62 commits) [i18nIgnore] docs: `pnpm install` → `pnpm add` (withastro#1324) [ci] format i18n(zh-cn): Update frontmatter.mdx (withastro#1362) [ci] format i18n(es): Update `index` (withastro#1360) [ci] format i18n(fr): Update index (withastro#1367) i18n(es): remove extra section (withastro#1370) i18n(ko-KR): update `index.mdx` (withastro#1363) [ci] format i18n(zh-cn): Update index.mdx (withastro#1361) docs(showcase): add OpenSaaS.sh (withastro#1359) feat(Testimonials): add testimonials to website (withastro#1104) [ci] format [ci] release (withastro#1332) fix: autogenerated sidebar alphabetical sort (withastro#1298) Avoid sidebar scrollbar hiding behind navbar (withastro#1353) Use spawnSync instead of execaSync in `git.ts` (withastro#1347) [ci] format [i18nIgnore] Add src alias (withastro#1322) ...

docs: fix pnpm install commands

6f0bc79

github-actions bot added the 📚 docs Documentation website changes label Jan 2, 2024

vercel bot deployed to Preview January 2, 2024 10:54 View deployment

at-the-vr approved these changes Jan 2, 2024

View reviewed changes

ElianCodes approved these changes Jan 2, 2024

View reviewed changes

kevinzunigacuellar approved these changes Jan 2, 2024

View reviewed changes

delucis reviewed Jan 4, 2024

View reviewed changes

dreyfus92 approved these changes Jan 11, 2024

View reviewed changes

HiDeoo added 2 commits January 15, 2024 10:27

[i18nIgnore] docs: fix pnpm install command in all languanges

ea10939

github-actions bot added the i18n Anything to do with internationalization & translation efforts label Jan 15, 2024

HiDeoo changed the title ~~docs: pnpm install → pnpm add~~ [i18nIgnore] docs: pnpm install → pnpm add Jan 15, 2024

vercel bot deployed to Preview – starlight January 15, 2024 09:43 View deployment

Merge branch 'main' into hd-docs-pnpm-install-add

cf0ca75

vercel bot deployed to Preview – starlight January 15, 2024 09:46 View deployment

delucis approved these changes Jan 15, 2024

View reviewed changes

HiDeoo merged commit b8ceac4 into withastro:main Jan 15, 2024
9 checks passed

HiDeoo deleted the hd-docs-pnpm-install-add branch January 15, 2024 10:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[i18nIgnore] docs: `pnpm install` → `pnpm add` #1324

[i18nIgnore] docs: `pnpm install` → `pnpm add` #1324

HiDeoo commented Jan 2, 2024 •

edited

Loading

changeset-bot bot commented Jan 2, 2024 •

edited

Loading

vercel bot commented Jan 2, 2024 •

edited

Loading

at-the-vr left a comment

ElianCodes left a comment

kevinzunigacuellar left a comment

delucis left a comment

dreyfus92 left a comment

HiDeoo commented Jan 13, 2024

HiDeoo commented Jan 15, 2024

delucis left a comment

[i18nIgnore] docs: pnpm install → pnpm add #1324

[i18nIgnore] docs: pnpm install → pnpm add #1324

Conversation

HiDeoo commented Jan 2, 2024 • edited Loading

What kind of changes does this PR include?

Description

changeset-bot bot commented Jan 2, 2024 • edited Loading

⚠️ No Changeset found

vercel bot commented Jan 2, 2024 • edited Loading

at-the-vr left a comment

Choose a reason for hiding this comment

ElianCodes left a comment

Choose a reason for hiding this comment

kevinzunigacuellar left a comment

Choose a reason for hiding this comment

delucis left a comment

Choose a reason for hiding this comment

dreyfus92 left a comment

Choose a reason for hiding this comment

HiDeoo commented Jan 13, 2024

HiDeoo commented Jan 15, 2024

delucis left a comment

Choose a reason for hiding this comment

[i18nIgnore] docs: `pnpm install` → `pnpm add` #1324

[i18nIgnore] docs: `pnpm install` → `pnpm add` #1324

HiDeoo commented Jan 2, 2024 •

edited

Loading

changeset-bot bot commented Jan 2, 2024 •

edited

Loading

vercel bot commented Jan 2, 2024 •

edited

Loading