From 47870cd9b29c9b287705866ba8eb2afc51b620bc Mon Sep 17 00:00:00 2001 From: Apurav Chauhan Date: Sat, 11 Aug 2018 20:13:39 +0530 Subject: [PATCH 1/2] 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. --- docs/getting-started-installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started-installation.md b/docs/getting-started-installation.md index e0169770e693..a74dfc6db928 100644 --- a/docs/getting-started-installation.md +++ b/docs/getting-started-installation.md @@ -13,7 +13,7 @@ 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 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 From e8ee0569a8364cae972988195615c3bcccc863f6 Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Sun, 12 Aug 2018 16:22:35 -0700 Subject: [PATCH 2/2] 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 a74dfc6db928..ce48531a3b87 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. Create a project if none exists and change the directory to this project's root. +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`.