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: update npm install command #1314

Closed
wants to merge 1 commit into from
Closed

Conversation

chenxsan
Copy link
Contributor

@chenxsan chenxsan commented Sep 5, 2021

Changes

  • Fix documentation

I believe astro should be installed under devDependencies instead of dependencies .

Testing

Not needed.

Docs

Not needed.

@chenxsan chenxsan requested a review from a team as a code owner September 5, 2021 06:08
@changeset-bot
Copy link

changeset-bot bot commented Sep 5, 2021

⚠️ No Changeset found

Latest commit: 1fde5b5

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
Copy link

vercel bot commented Sep 5, 2021

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployments, click below or on the icon next to each commit.

astro-docs – ./docs

🔍 Inspect: https://vercel.com/pikapkg/astro-docs/8Lr4FsasJET6VrT123hevSm28XTo
✅ Preview: https://astro-docs-git-fork-chenxsan-patch-1-pikapkg.vercel.app

astro-www – ./www

🔍 Inspect: https://vercel.com/pikapkg/astro-www/GHgUmqMcJ4CxUtoAZ3WebJ7dMwzC
✅ Preview: https://astro-www-git-fork-chenxsan-patch-1-pikapkg.vercel.app

@jasikpark
Copy link
Contributor

I believe it should be under dependencies since it is required to build the project, rather than being a tool used for development of the website you might work on - https://docs.npmjs.com/cli/v7/configuring-npm/package-json#devdependencies

For example, Netlify does not install devDependencies. (I believe that to be true but cannot find it https://docs.netlify.com/configure-builds/manage-dependencies/)

@FredKSchott
Copy link
Member

Thanks for the contribution! I actually personally prefer installing Astro as a dev dependency, since I think it would fall under the title of "tool used to build your website". BUT, I understand that not everyone agrees on this, and ultimately in most projects it's a non-issue that falls under personal preference.

Similar to how we show npm install and assume that yarn/pnpm users know how to map this to their own CLI, I think anyone who wants to install as a dev dependencies knows to add the --save-dev flag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants