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.

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

Better starter docs #5966

Merged
merged 3 commits into from
Jun 21, 2018
Merged

Better starter docs #5966

merged 3 commits into from
Jun 21, 2018

Conversation

wuweiweiwu
Copy link
Contributor

closes: #5866

clarify what starters are :)

@wuweiweiwu
Copy link
Contributor Author

Failed ci:

/home/travis/build/gatsbyjs/gatsby/packages/gatsby-link/src/index.js
  54:1  error  componentWillReceiveProps is deprecated since React 16.3.0, use UNSAFE_componentWillReceiveProps instead, see https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops  react/no-deprecated
/home/travis/build/gatsbyjs/gatsby/packages/gatsby-react-router-scroll/src/ScrollContainer.js
  19:1  error  componentWillReceiveProps is deprecated since React 16.3.0, use UNSAFE_componentWillReceiveProps instead, see https://reactjs.org/docs/react-component.html#unsafe_componentwillreceiveprops  react/no-deprecated

seems that some components in v1 still use deprecated lifecycles :(

preconfigured to help you get moving faster on creating a certain type of site.
The Gatsby CLI tool lets you install “starters”. These are boilerplate Gatsby sites maintained by the community.
`gatsby new` helps you start your project by cloning the boilerplate, installing dependencies, and clearing git history.
If you are familiar with `git` this is the same as `git clone <starter repo url> && rm -rf .git/ && yarn` (or `npm i`).
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 wondering if it's necessary to explain about the git part? also you missed cd folder

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Gotcha. I think it makes sense to get rid of the parts starting from "If you are familar ..."

Copy link
Contributor

@m-allanson m-allanson left a comment

Choose a reason for hiding this comment

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

Nice clarification, thanks @wuweiweiwu 👍

@m-allanson m-allanson merged commit fd3e54e into gatsbyjs:v1 Jun 21, 2018
m-allanson pushed a commit that referenced this pull request Jun 21, 2018
* better starter docs

* Removing gnarly details
@m-allanson
Copy link
Contributor

I've cherry-picked this across to the master branch so it'll show up on next.gatsbyjs.org too.

KyleAMathews pushed a commit that referenced this pull request Jun 21, 2018
* better starter docs

* Removing gnarly details
@wuweiweiwu
Copy link
Contributor Author

Awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants