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.

Sign up for GitHub

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

Jump to bottom

Simplify installation steps #519

Merged
merged 3 commits into from
Apr 23, 2018
Merged

Simplify installation steps #519

merged 3 commits into from
Apr 23, 2018

Conversation

longility
Copy link
Contributor

Motivation

After going through installation steps for first time, I had thoughts on some changes that could further simplify new users.

  • Since docusaurus-init is run seldomly, npx keeps it simpler, and subsequent runs will be using the latest version.
  • outdated command provides more meaningful view of current and latest version
  • Moved file and directory example down into Verifying Installation section as it is not an actual step to installation, but merely for verifying.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

None

Related PRs

None

simplify installation steps
d4b8c62 
Since docusaurus-init is run seldomly, npx keeps it simpler,
and subsequent runs will be using the latest version.

Outdated provides more meaningful view of current and latest version
@longility
Copy link
Contributor Author

@JoelMarcey, from our conversation on #506. This is my update. Do you think this helps, leave as is, or do you have other suggestions?

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 20, 2018
@JoelMarcey
Copy link
Contributor

@longility Hi! Sorry for the delay here. I am on currently on vacation. I think I may be ok with this, although I need to think more if i want to showcase npx so prominently in the installation instructions. I will give it some more thought.

@longility
Copy link
Contributor Author

@JoelMarcey It's all good. I know CRA uses npx in their documentation.

@WoZ
Copy link

WoZ commented Apr 3, 2018

@JoelMarcey @longility

npx comes with npm 5.2+ and ships with node 8.2+. I think that it's good idea to mention that user must install node 8.2+ to run npx or continue with older version but with previous version of installation manual.

@longility
Copy link
Contributor Author

@WoZ I updated to provide info on what node version is needed to running npx. Thanks for your suggestion.

@longility longility mentioned this pull request Apr 5, 2018
Closed
@yangshun yangshun changed the title simplify installation steps Simplify installation steps Apr 23, 2018
@yangshun
Copy link
Contributor

@longility Sorry for the delay. I think the new instructions look great! I made the yarn/npm outdated and upgrade commands more specific to docusaurus so that users will only see relevant output in their terminal. Thanks for the PR! 🎉

@yangshun yangshun merged commit 33d4e4a into facebook:master Apr 23, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yangshun yangshun yangshun approved these changes

Assignees
No one assigned
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@longility @JoelMarcey @WoZ @yangshun @facebook-github-bot