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

[docs] suggestion: clarify what starters are #5866

Closed
tsiq-swyx opened this issue Jun 12, 2018 · 1 comment
Closed

[docs] suggestion: clarify what starters are #5866

tsiq-swyx opened this issue Jun 12, 2018 · 1 comment
Labels
help wanted Issue with a clear description that the community can help with. stale? Issue that may be closed soon due to the original author not responding any more. type: documentation An issue or pull request for improving or updating Gatsby's documentation

Comments

@tsiq-swyx
Copy link
Contributor

tsiq-swyx commented Jun 12, 2018

problem statement

Currently our docs say:

The Gatsby CLI tool lets you install “starters”. These are partially built sites preconfigured to help you get moving faster on creating a certain type of site.

i think this might send the wrong message that "starters" are a special concept that needs several requirements, in the way that create-react-app has special requirements if you want to do custom react-scripts. this was my initial assumption when learning gatsby and it was wrong. it's also a barrier to creating more starters.

it should be more obvious that gatsby new is no more than git clone && rm -rf .git/ && yarn (or npm i)

suggested solution

Change the wording in the docs:

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 && rm -rf .git/ && yarn` (or `npm i`).

future ideas

enhance the CLI to offer official and recently used starters

or at least directly launch to the starter showcase. (#5334)

@tsiq-swyx tsiq-swyx changed the title [docs] clarify what starters are [docs] suggestion: clarify what starters are Jun 12, 2018
@m-allanson m-allanson added help wanted Issue with a clear description that the community can help with. type: documentation An issue or pull request for improving or updating Gatsby's documentation labels Jun 13, 2018
@gatsbot gatsbot bot added the stale? Issue that may be closed soon due to the original author not responding any more. label Dec 2, 2018
@gatsbot
Copy link

gatsbot bot commented Dec 2, 2018

Old issues will be closed after 30 days of inactivity. This issue has been quiet for 20 days and is being marked as stale. Reply here or add the label "not stale" to keep this issue open!

@LekoArts LekoArts closed this as completed Dec 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Issue with a clear description that the community can help with. stale? Issue that may be closed soon due to the original author not responding any more. type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

No branches or pull requests

3 participants