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

docs: use hello-world starter in quick start guide instead of default starter #25914

Merged
merged 3 commits into from
Jul 23, 2020
Merged

docs: use hello-world starter in quick start guide instead of default starter #25914

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edaa130
Small tweak to see if we can reduce errors driven by the default star…
jsumnersmith Jul 21, 2020
b28f599
chore: format
Jul 21, 2020
d0c9544
Reverted working directory name
jsumnersmith Jul 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/docs/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,13 @@ npm install -g gatsby-cli
### Create a new site

```shell
gatsby new gatsby-site
gatsby new hello-world https://github.com/gatsbyjs/gatsby-starter-hello-world
```

### Change directories into site folder

```shell
cd gatsby-site
cd hello-world
Copy link
Contributor

Choose a reason for hiding this comment

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

What's the thinking behind changing this? (and above ☝️ )

Not against it -- just curious!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just figured it would better signal that this was a smaller quick start. You are literally doing a hello-world and not a full site. Not a necessary part of the change!

Copy link
Contributor

Choose a reason for hiding this comment

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

I'm cool with it!

Copy link
Contributor

Choose a reason for hiding this comment

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

We use the Quick Start as a jumping off point for other docs, including the manual recipes section: https://gatsbyjs.org/docs/recipes/

It would be good to consider those use cases in addition to a standalone Quick Start exercise. But I'd defer to @AishaBlake!

Copy link
Contributor

Choose a reason for hiding this comment

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

Good point! Best as I can tell, the recipe at docs/recipes/working-with-plugins.md would need to be updated.

Copy link
Contributor

Choose a reason for hiding this comment

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

Many of them list "A Gatsby site" as a prerequisite, and they link to the Quick Start. Likely in other parts of the docs, too.

Copy link
Contributor

Choose a reason for hiding this comment

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

I think that's phraseology? I don't see that being confusing after this change?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Got it. I think leaving the new working directory name as is is probably fine and not essential to this test. If we find it's successful and that it would be a useful long term change, we update the directory name here and the name in the links in the current manual recipes section.

As best I can tell, none of the recipes are dependent on having the default starter from the Quick Start so this shouldn't affect users going through those.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Working directory name was reverted to gatsby-site on #d0c9544

```

### Start development server
Expand All @@ -39,7 +39,7 @@ gatsby develop

Gatsby will start a hot-reloading development environment accessible by default at `http://localhost:8000`.

Try editing the JavaScript pages in `src/pages`. Saved changes will live reload in the browser.
Try editing the home page in `src/pages/index.js`. Saved changes will live reload in the browser.
Copy link
Contributor

Choose a reason for hiding this comment

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

Good tweak!


### Create a production build

Expand Down