[Gatsby] README.md instructions#10945
Conversation
www/README.md
Outdated
|
|
||
| ### Running locally | ||
|
|
||
| 1. `yarn dev` to build the site with Gatsby, a (React-based!) static site generator |
There was a problem hiding this comment.
perhaps change to "to start the hot-reloading development server powered by Gatsby"?
There was a problem hiding this comment.
Sure, and drop the a (React-based!) static site generator?
| ### Installation | ||
|
|
||
| 1. `cd www` to go into the website project | ||
| 1. `yarn` to install the website's NPM dependencies |
There was a problem hiding this comment.
You also need to run yarn at the root right? For Prettier, etc?
There was a problem hiding this comment.
Good spot, thanks
www/README.md
Outdated
| 1. Git | ||
| 1. Node: install version 7.6 or greater | ||
| 1. Yarn: `npm i -g yarn` to install it globally via NPM | ||
| 1. A clone of the [https://github.com/facebook/react](React repo) on your local machine |
There was a problem hiding this comment.
Wrong order in Markdown link (doesn't render)
www/README.md
Outdated
|
|
||
| 1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fixed header logo on Android`) to stage and commit your changes | ||
| 1. `git push yourname wwwTheNameOfMyChange` | ||
| 1. Go to the [https://github.com/facebook/react](React repo) and you should see recently pushed branches. |
|
|
||
| 1. Follow the "Running locally" instructions | ||
| 1. Save the files and check in the browser (any React components in `src/components` or `src/templates`) will hot-reload) | ||
|
|
There was a problem hiding this comment.
Worth noting that if you change site internals like plugins, it may be necessary to remove .cache directory and restart the server for changes to take effect.
There was a problem hiding this comment.
Good idea. Split these out into different procedures
|
Deploy preview ready! Built with commit 6ee9c67 |
www/README.md
Outdated
| 1. Follow the "Running locally" instructions | ||
| 1. Save the files and check in the browser | ||
| 1. Any React components in `src/components` or `src/templates`) will hot-reload | ||
| 1. Some other JS files, such as `html.js`, may require a full reload |
There was a problem hiding this comment.
Changing html.js triggers a page refresh automatically so this line isn't necessary
There was a problem hiding this comment.
Oh yeah! Never noticed that before 👍
|
|
||
| 1. Follow the "Running locally" instructions | ||
| 1. Save the files and check in the browser | ||
| 1. Any React components in `src/components` or `src/templates` will hot-reload |
There was a problem hiding this comment.
Had one more suggestion :-)
"Edits to markdown files in /docs and to React components in…"
5 participants
Because the new React-based docs are a great way for people to contribute, I figured a more thorough README.md could be useful.
What do you think?
cc @bvaughn @gaearon