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(v2): fix typo in command on installation page #2886

Merged
merged 2 commits into from
Jun 6, 2020

Conversation

pglezen
Copy link
Contributor

@pglezen pglezen commented Jun 4, 2020

Checking the docusaurus version should be done with

npx docusaurus --version

not

npm docusaurus --version

otherwise it prints the version of npm instead of docusaurus.

Motivation

(Write your motivation here.)

Have you read the Contributing Guidelines on pull requests?

(Write your answer here.)

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

Checking the docusaurus version should be done with

```
npx docusaurus --version
```

not 

```
npm docusaurus --version
```

otherwise it prints the version of `npm` instead of `docusaurus`.
@pglezen pglezen requested a review from yangshun as a code owner June 4, 2020 19:59
@facebook-github-bot
Copy link
Contributor

Hi @pglezen!

Thank you for your pull request and welcome to our community.We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at [email protected]. Thanks!

@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Jun 4, 2020

Deploy preview for docusaurus-2 ready!

Built with commit dd58e10

https://deploy-preview-2886--docusaurus-2.netlify.app

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jun 4, 2020
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

Copy link
Contributor

@yangshun yangshun left a comment

Choose a reason for hiding this comment

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

Thank you! Could you also change website/docs/installation.md? That's the most updated version of the docs.

Specifying `npm` for the version will yield the version of NPM
instead of docusaurus itself.  Use `npx` for the docusaurus version.
@lex111 lex111 changed the title docs: fix installation.md typo for version info docs(v2): fix typo in command on installation page Jun 6, 2020
@lex111 lex111 merged commit 4278ceb into facebook:master Jun 6, 2020
@lex111
Copy link
Contributor

lex111 commented Jun 6, 2020

@pglezen thank you!

@pglezen pglezen deleted the patch-1 branch June 6, 2020 02:05
@slorber slorber added the pr: documentation This PR works on the website or other text documents in the repo. label Jun 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants