From af48a3e1030d01265ec02d5be705a365e57ee3c6 Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Mon, 21 Feb 2022 11:44:11 +0100 Subject: [PATCH 01/12] initial doc update --- docs/docs/tutorial/part-1/index.mdx | 29 ++++++++++++++++++++++++++++- 1 file changed, 28 insertions(+), 1 deletion(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 2ae2fc217dc5e..dc700d59de131 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -58,7 +58,7 @@ To create your first Gatsby site, you're going to use a command from the Gatsby -**Note:** For this Tutorial, your Gatsby CLI should be v3 or newer. To check what version you have installed, run the following command: +**Note:** For this Tutorial, your Gatsby CLI should be v4.8 or newer. To check what version you have installed, run the following command: ```shell gatsby --version @@ -88,6 +88,17 @@ gatsby new +You can also generate a Gatsby site without needing to go through all the prompts. In this case, the CLI will use the default values for the prompts except for the site name which you'll need to pass. +You can do this by running the following command from the command line: + +```shell:title=Desktop + gatsby new -y +``` + + + + + **Having trouble with `gatsby new`?** If you had trouble globally installing `gatsby-cli` in Part 0, you can also create a new site by running `npm init gatsby` from the command line instead of `gatsby new`. @@ -106,9 +117,25 @@ What would you like to name the folder where your site will be created? ✔ Desktop/ my-first-gatsby-site ``` +5. When the prompt asks, **"Will you be using JavaScript or TypeScript?"** choose between JavaScript or TypeScript. + +```shell +? Will you be using JavaScript or TypeScript? +(Single choice) Arrow keys to move, enter to confirm + JavaScript +❯ TypeScript +``` + + + +This question will be skipped if you passed in a `-ts` flag at the beginning i.e `gatsby new -ts`. This indicates that you want to use TypeScript. + + + 5. When the prompt asks, **"Will you be using a CMS?"** select **"No (or I'll add it later)"**. ```shell + ✔ Will you be using a CMS? · No (or I'll add it later) ``` From 2b07a7524de40b37aba34a493d5a2f633ece6fd4 Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Mon, 21 Feb 2022 11:59:35 +0100 Subject: [PATCH 02/12] improve clarity --- docs/docs/tutorial/part-1/index.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index dc700d59de131..93f8f841a4209 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -128,7 +128,8 @@ What would you like to name the folder where your site will be created? -This question will be skipped if you passed in a `-ts` flag at the beginning i.e `gatsby new -ts`. This indicates that you want to use TypeScript. +This question will be skipped if you passed in a `-ts` flag at the beginning i.e `gatsby new -ts`. +This indicates that you want to use TypeScript hence our [Minimal Typescript Starter](https://github.com/gatsbyjs/gatsby/tree/master/starters/gatsby-starter-minimal-ts) will be pulled in as the template. From 4eccc76c360c1f91f8c4b673b42d61302761e058 Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Mon, 21 Feb 2022 12:02:09 +0100 Subject: [PATCH 03/12] update numbering --- docs/docs/tutorial/part-1/index.mdx | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 93f8f841a4209..c589f723a3ca8 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -133,7 +133,7 @@ This indicates that you want to use TypeScript hence our [Minimal Typescript Sta -5. When the prompt asks, **"Will you be using a CMS?"** select **"No (or I'll add it later)"**. +6. When the prompt asks, **"Will you be using a CMS?"** select **"No (or I'll add it later)"**. ```shell @@ -149,21 +149,21 @@ But in this first site, you'll set things up manually to learn about how Gatsby' -6. When the prompt asks, **"Would you like to install a styling system?"** select **"No (or I'll add it later)"**. (You'll add styles manually later.) +7. When the prompt asks, **"Would you like to install a styling system?"** select **"No (or I'll add it later)"**. (You'll add styles manually later.) ```shell ✔ Would you like to install a styling system? · No (or I'll add it later) ``` -7. When the prompt asks, **"Would you like to install additional features with other plugins?"** use the arrow and Enter keys to select **"Done"**. +8. When the prompt asks, **"Would you like to install additional features with other plugins?"** use the arrow and Enter keys to select **"Done"**. ```shell ✔ Would you like to install additional features with other plugins? · Done ``` -8. The prompt will show you a summary of what `gatsby new` will do. It should look something like the output below. +9. The prompt will show you a summary of what `gatsby new` will do. It should look something like the output below. ```shell Thanks! Here's what we'll now do: @@ -174,7 +174,7 @@ Thanks! Here's what we'll now do: ? Shall we do this? (Y/n) › Yes ``` -9. When the prompt asks, **"Shall we do this?"** enter **"Y"**. The `gatsby new` command will start building your site. Your internet download speed will affect how long this command takes to run. After it finishes, you should see a message like this: +10. When the prompt asks, **"Shall we do this?"** enter **"Y"**. The `gatsby new` command will start building your site. Your internet download speed will affect how long this command takes to run. After it finishes, you should see a message like this: ```shell 🎉 Your new Gatsby site My First Gatsby Site has been successfully From e4614aba151b1077546eb00dbc24119f59448566 Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Mon, 21 Feb 2022 12:58:25 +0100 Subject: [PATCH 04/12] update docs --- docs/docs/tutorial/part-1/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index c589f723a3ca8..798c1bbb2ba5e 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -88,7 +88,7 @@ gatsby new -You can also generate a Gatsby site without needing to go through all the prompts. In this case, the CLI will use the default values for the prompts except for the site name which you'll need to pass. +You can also generate a Gatsby site without needing to go through all the prompts. In this case, the the defaults will be used except for the site name which you'll need to pass. You can do this by running the following command from the command line: ```shell:title=Desktop From 64448a00cb6bd4d824f9c04db404bdaed5395f0d Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Mon, 21 Feb 2022 15:49:36 +0100 Subject: [PATCH 05/12] add ts doc reference --- docs/docs/tutorial/part-1/index.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 798c1bbb2ba5e..10c1b5a4adeed 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -130,6 +130,7 @@ What would you like to name the folder where your site will be created? This question will be skipped if you passed in a `-ts` flag at the beginning i.e `gatsby new -ts`. This indicates that you want to use TypeScript hence our [Minimal Typescript Starter](https://github.com/gatsbyjs/gatsby/tree/master/starters/gatsby-starter-minimal-ts) will be pulled in as the template. +Using TypeScript? Also checkout our [TypeScript Docs](/how-to/custom-configuration/typescript/) From 5a2fda254bf4c1f84d0cbaa541a0d608e771099b Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Tue, 22 Feb 2022 09:20:31 +0100 Subject: [PATCH 06/12] Update docs/docs/tutorial/part-1/index.mdx Co-authored-by: Lennart --- docs/docs/tutorial/part-1/index.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 10c1b5a4adeed..62d9b1ed1b218 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -122,8 +122,8 @@ What would you like to name the folder where your site will be created? ```shell ? Will you be using JavaScript or TypeScript? (Single choice) Arrow keys to move, enter to confirm - JavaScript -❯ TypeScript +❯ JavaScript + TypeScript ``` From 36ae0be84a114126b79f56a95dfa9608c616432b Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Tue, 22 Feb 2022 09:20:48 +0100 Subject: [PATCH 07/12] Update docs/docs/tutorial/part-1/index.mdx Co-authored-by: Lennart --- docs/docs/tutorial/part-1/index.mdx | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 62d9b1ed1b218..c0fc06109608a 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -137,7 +137,6 @@ Using TypeScript? Also checkout our [TypeScript Docs](/how-to/custom-configurati 6. When the prompt asks, **"Will you be using a CMS?"** select **"No (or I'll add it later)"**. ```shell - ✔ Will you be using a CMS? · No (or I'll add it later) ``` From 4c87e7350451e7f9ed41150c892147b9bdb3aaec Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Tue, 22 Feb 2022 09:21:09 +0100 Subject: [PATCH 08/12] Update docs/docs/tutorial/part-1/index.mdx Co-authored-by: Lennart --- docs/docs/tutorial/part-1/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index c0fc06109608a..1b0ea187285ff 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -117,7 +117,7 @@ What would you like to name the folder where your site will be created? ✔ Desktop/ my-first-gatsby-site ``` -5. When the prompt asks, **"Will you be using JavaScript or TypeScript?"** choose between JavaScript or TypeScript. +5. When the prompt asks, **"Will you be using JavaScript or TypeScript?"** choose JavaScript. ```shell ? Will you be using JavaScript or TypeScript? From 463318bf8a8df822f9bea8b49e570b8260c335c8 Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Tue, 22 Feb 2022 10:19:36 +0100 Subject: [PATCH 09/12] update docs --- docs/docs/tutorial/part-1/index.mdx | 15 +-------------- 1 file changed, 1 insertion(+), 14 deletions(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 1b0ea187285ff..72793524549b6 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -88,17 +88,6 @@ gatsby new -You can also generate a Gatsby site without needing to go through all the prompts. In this case, the the defaults will be used except for the site name which you'll need to pass. -You can do this by running the following command from the command line: - -```shell:title=Desktop - gatsby new -y -``` - - - - - **Having trouble with `gatsby new`?** If you had trouble globally installing `gatsby-cli` in Part 0, you can also create a new site by running `npm init gatsby` from the command line instead of `gatsby new`. @@ -128,9 +117,7 @@ What would you like to name the folder where your site will be created? -This question will be skipped if you passed in a `-ts` flag at the beginning i.e `gatsby new -ts`. -This indicates that you want to use TypeScript hence our [Minimal Typescript Starter](https://github.com/gatsbyjs/gatsby/tree/master/starters/gatsby-starter-minimal-ts) will be pulled in as the template. -Using TypeScript? Also checkout our [TypeScript Docs](/how-to/custom-configuration/typescript/) +For this tutorial, we're using JavaScript, feel free to select the TypeScript option if you're interested in using TypeScript instead. Using TypeScript? checkout our [TypeScript Docs](/how-to/custom-configuration/typescript/) From a02e376636f8c21302e30774dc5f0021f7333665 Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Tue, 22 Feb 2022 11:26:51 +0100 Subject: [PATCH 10/12] Update docs/docs/tutorial/part-1/index.mdx Co-authored-by: Lennart --- docs/docs/tutorial/part-1/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 72793524549b6..2f6d327c79caf 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -106,7 +106,7 @@ What would you like to name the folder where your site will be created? ✔ Desktop/ my-first-gatsby-site ``` -5. When the prompt asks, **"Will you be using JavaScript or TypeScript?"** choose JavaScript. +5. When the prompt asks, **"Will you be using JavaScript or TypeScript?"** choose **JavaScript**. ```shell ? Will you be using JavaScript or TypeScript? From eb1c8eb67ae665aa5aaa87cd459643eef4ae859b Mon Sep 17 00:00:00 2001 From: Jude Agboola Date: Tue, 22 Feb 2022 11:27:15 +0100 Subject: [PATCH 11/12] Update docs/docs/tutorial/part-1/index.mdx Co-authored-by: Lennart --- docs/docs/tutorial/part-1/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index 2f6d327c79caf..bfa4e7aff6c44 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -117,7 +117,7 @@ What would you like to name the folder where your site will be created? -For this tutorial, we're using JavaScript, feel free to select the TypeScript option if you're interested in using TypeScript instead. Using TypeScript? checkout our [TypeScript Docs](/how-to/custom-configuration/typescript/) +This tutorial doesn't require any prior TypeScript knowledge as it uses JavaScript. If you're familiar with TypeScript you can read the [Gatsby and TypeScript guide](/how-to/custom-configuration/typescript/) to learn about typings, files, and conventions. If you want to use TypeScript we recommend going through the tutorial first and then only afterwards convert the project to TypeScript. From fef8d4bebbe22a790fde7aad68c958c83337e0f9 Mon Sep 17 00:00:00 2001 From: Lennart Date: Tue, 22 Feb 2022 11:53:35 +0100 Subject: [PATCH 12/12] Update index.mdx --- docs/docs/tutorial/part-1/index.mdx | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/docs/tutorial/part-1/index.mdx b/docs/docs/tutorial/part-1/index.mdx index bfa4e7aff6c44..ba79c10f32f0a 100644 --- a/docs/docs/tutorial/part-1/index.mdx +++ b/docs/docs/tutorial/part-1/index.mdx @@ -109,8 +109,7 @@ What would you like to name the folder where your site will be created? 5. When the prompt asks, **"Will you be using JavaScript or TypeScript?"** choose **JavaScript**. ```shell -? Will you be using JavaScript or TypeScript? -(Single choice) Arrow keys to move, enter to confirm +Will you be using JavaScript or TypeScript? ❯ JavaScript TypeScript ```