From acd4f3f9845781c30c9f36db8a2b299734e0c61b Mon Sep 17 00:00:00 2001 From: Apurav Chauhan Date: Mon, 13 Aug 2018 13:59:45 +0530 Subject: [PATCH] Update getting started page to be more intuitive (#900) * Updating step 2 to be more intuitive Use of word Github is very confusing. When starting, most of devs wont have an existing github repo. And normally not everyone will be using Github. Since devs will be following this step by step: we need to stress on telling them to create a new or use existing local project folder which may or may not be a github repo. * Update getting-started-installation.md --- docs/getting-started-installation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/getting-started-installation.md b/docs/getting-started-installation.md index e0169770e6..ce48531a3b 100644 --- a/docs/getting-started-installation.md +++ b/docs/getting-started-installation.md @@ -13,12 +13,14 @@ We have created an easy script that will get all of the infrastructure set up fo > You have to be on Node >= 8.x and Yarn >= 1.5. -1. Change directory to the root of your project's GitHub repo. +1. Create a project, if none exists, and change your the directory to this project's root. You will be creating the docs in this directory. The root directory may contain other files. The Docusaurus installation script will create two new directories: `docs-examples-from-docusaurus` and `website`. + > Commonly, either an existing or newly created GitHub project will be the location for your Docusaurus site, but that is not mandatory to use Docusaurus. + 1. Run the Docusaurus installation script: `npx docusaurus-init`. > If you don't have Node 8.2+ or if you prefer to install Docusaurus globally, run `yarn global add docusaurus-init` or `npm install --global docusaurus-init`. After that, run `docusaurus-init`.