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: Suggested edits to Getting Started for npx usage #270

Merged
merged 3 commits into from
Feb 15, 2021
Merged

Conversation

abernix
Copy link
Member

@abernix abernix commented Feb 15, 2021

This adds a clarifying point to the Getting Started instructions that notes that
the -p (i.e., --package) argument must be passed in order to define which
package provides the rover command. (Note that rover is published to npm
as the @apollo/rover package, not rover; If rover was published to rover,
passing the -p flag would not be required.)

This adds a clarifying point to the Getting Started instructions that notes that
the `-p` (i.e., `--package`) argument must be passed in order to define which
package provides the `rover` command.  (Note that `rover` is published to npm
as the `@apollo/rover` package, not `rover`; If `rover` was published to `rover`,
passing the `-p` flag would not be required.)
@abernix abernix added docs 📝 improvements or additions to docs on the docs site docs - github labels Feb 15, 2021
@@ -23,9 +23,11 @@ iwr 'https://raw.githubusercontent.com/apollographql/rover/v0.0.1/installers/bin

Rover is distributed on npm for easy integration with your JavaScript projects.

##### devDependency install
Copy link
Member Author

Choose a reason for hiding this comment

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

Note I made this adjustment because there is no property called devDependency, but rather, devDependencies.

Copy link
Member

@lrlna lrlna left a comment

Choose a reason for hiding this comment

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

Thanks @abernix!

@lrlna lrlna merged commit ef73604 into main Feb 15, 2021
@lrlna lrlna deleted the abernix/npx-usage branch February 15, 2021 14:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs 📝 improvements or additions to docs on the docs site
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants