Skip to content

Commit

Permalink
[v2] merge master into v2 (#5451)
Browse files Browse the repository at this point in the history
* Use index within container

Confusing as to what is being asked. Later, the docs say to `import Container from "../components/container";`

* Pass through GTM environment params if present

Signed-off-by: Spencer Sanchez <dev@spencersanchez.com>

* Add abinavseelan.com to Showcase

* Add Dovetail (dovetailapp.com) to website examples

Thanks for creating Gatsby and for all of your hard work! We’ve enjoyed building our new marketing website with it.

* change link of `gatsby-advanced-blog` in docs

* Remove outdated contributing notes from gatsby-remark-prismjs

* Typo: Return to wrong file

I was doing the gatsby.js tutorial and I was running into one issue, the tutorial said to return to index.js, but it should be to my-files.js, I eventually figured out that this was probably just a typo, but for a long time I kept changing my index.js file and didn't understand what I was doing wrong, turns out I was editing the wrong file. For so far I have enjoyed gatsby.js, I want to use it for my personal portfolio.

* Fix distance between masthead and the icon (#5068)

On mobile, the masthead is overlapping with the Gatsby icon.

* Update CONTRIBUTING.md

* Update README.md

Per issue #5073

* Add better-queue to dependencies

* Remove index.js for more consistent paths

* removing "a"

* pre-inferring data sanitazation (#5050)

* extractFieldExamples: omit not defined fields

this is especially helpful with ___NODE fields - plugins/users don't have to test if there are any values and be confident that empty ___NODE values or arrays will just be omitted and not error out during bootstrap

* sanitize field owner key when using createNodeField with name containing ___NODE

this fixes issue with inferring fieldOwners types - gatsby would try to link to not existing nodes

* Add getRenderer method (#5017)

* Add getRenderer method

Signed-off-by: slorber <lorber.sebastien@gmail.com>

* upgrade example versions

Signed-off-by: slorber <lorber.sebastien@gmail.com>

* change name to renderer

* Change name to replaceHydrateFunction

* document replaceHydrateFunction

* fix(gatsby): remove `.js` suffixes in require() to allow transpilation (#5087)

In earlier v1, one could write files such as `gatsby-config` in typescript and
use babel to transpile the file into js on the fly via
`babel-node --presets @babel/preset-typescript --extensions '.ts' gatsby
develop`. However, it's no longer possible in recent releases.

The reason is that the current implementation put a `.js` suffix on each
require(`gatsby-${env}.js`), which blocks `gatsby-{$env}` files being transpiled
from other languages via babel. The PR addresses this problem by removing the
unnecessary suffix and preserving the integrity.

Signed-off-by: Alvis HT Tang <alvis@hilbert.space>

* Publish

 - gatsby-plugin-google-tagmanager@1.0.18
 - gatsby-plugin-sitemap@1.2.23
 - gatsby-remark-prismjs@2.0.2
 - gatsby-source-drupal@2.0.36
 - gatsby-source-filesystem@1.5.34
 - gatsby-source-wordpress@2.0.82
 - gatsby@1.9.254

* stylus plugin tests

Signed-off-by: Jan Winterfeld <jan@markenbegeisterung.de>

* add learnstorybook.com to showcase

* Bump yargs version to get help and version for free by default

* Update manifest extension to .webmanifest

Reason: https://sonarwhal.com/docs/user-guide/rules/rule-manifest-file-extension/

* Updated link to file

* team development workflows (#5084)

* team development workflows

* Small typos

* Revert "Small typos"

This reverts commit ee7bc36.

* Revert "team development workflows"

This reverts commit a9e5498.

* move doc to blog

* excerpt

* Publish

 - gatsby-cli@1.1.51
 - gatsby-plugin-manifest@1.0.21
 - gatsby-plugin-stylus@1.1.20
 - gatsby@1.9.255

* Hyperlinks, optionality, and "easy" (#5154)

Added a few changes. This document needs to be reorganized eventually; I just want to add these notes in the fastest way possible now so I don't forget them.

* Add bartvanderwaerden.com to showcase (#5152)

* I guess I found the wrong word... (#5088)

I think line 308's `src/pages/my-files.js` is wrong.
It should be `src/pages/index.js` isn't it?

* Add two missing spaces (minor validation error) (#5150)

My previous commit missed adding a space after the backup blank `src=""` and `alt=""` attributes. This causes an HTML validation error when no `alt` value is supplied.

This commit simply adds those missing spaces (i.e. `src="" ` and `alt="" `) so there will always be a space between attributes.

* Adjust image processing example queries (#5158)

* adjust queries to not use id as way to select by filenames

this will stop working in gatsby v2

* add link to code

* Update KaTeX to 0.9.0 (#4712)

* Update KaTeX to 0.9.0

* Update snapshots

* DCO bye-bye (#5165)

* source-contentful: Add environment support (#5142)

* source-contentful: Add environment support

* fix lint

* fix default locale logix

* log error

* Update lock file

* Ulog the error

* Update package-lock.json

* revert lock changes, test shrinkwrap

* remove shrinkwrap, it's unused after all, add yarn resolutions

* cleanup debug console logs

* Link an example that uses gatsby-transformer-json (#5169)

* Publish

 - gatsby-image@1.0.48
 - gatsby-remark-katex@1.0.14
 - gatsby-source-contentful@1.3.48
 - gatsby-transformer-json@1.0.17

* Update RNW plugin and example (#5174)

* Update RNW example to use new plugin version

Signed-off-by: slorber <lorber.sebastien@gmail.com>

* Update React in example

Signed-off-by: slorber <lorber.sebastien@gmail.com>

* Enhance RNW example

Signed-off-by: slorber <lorber.sebastien@gmail.com>

* Add link to online demo

Signed-off-by: slorber <lorber.sebastien@gmail.com>

* Add screenshot

Signed-off-by: slorber <lorber.sebastien@gmail.com>

* Update createRemoteFileNode documentation (#5171)

* Update createRemoteFileNode documentation

* Update README.md

* Fix replaceHydrateFunction doc (#5175)

* Fix replaceHydrateFunction doc

* Add spaces

* Update "how gatsby works" documentation (#243) (#5181)

* Add a note about CNAME file in `static`

* Fix typo in the .eslintrc file (#5173)

* added my site (#5172)

* Added rafael.do (#5199)

* Add Eviction Free NYC blog post and link to site (#5159)

* Add evictionfreenyc.org to showcase

* Add Eviction Free NYC blog post

* Fixing a typo

* Copy edits

* Self-contained images

* [Ready 4 Review] SQIP - Vectorized primitive image previews (#4205)

* first working version with Contentful assets only

* add readme

* respect width, height, aspect ratio, cropping, resize focus and background

* add support for gatsby-transformer-sharp

* integrate in gatsbygram

* avoid useless regeneration cus contentDigest changes

* proper way to get absolute path to ImageSharp nodes

* queue preview generation and cache results on disk

* upgrade to latest node-sqip to get rid of the GoLang dependency

* replace custom svg data uri function with package

* prepare images via sharp plugin and allow sharp transformations

* load cached svg properly from disk

* fix queue resolving to early

* set contentful images to 400px

* implement new sharp transformation awareness feature

* WIP - extract generation and write first pseudo test

* fix styling for gatsbygram post detail

* finalize unit tests for actual sqip implementation

* use 256px input image width to match sqip/primitive default

* add using-sqip example page

* some cleanup

* clean up example and enhance polaroid effect

* fix using-sqip dependency

* remove base64 since it was not implemented and is bad for compression

* remove sqip from gatsbygram example

* simplify tests

* Small change to trigger build

* Publish

 - gatsby-plugin-sharp@1.6.44
 - gatsby-remark-images@1.5.63
 - gatsby-source-drupal@2.0.37
 - gatsby-source-filesystem@1.5.35
 - gatsby-source-wordpress@2.0.83
 - gatsby-transformer-sharp@1.6.24
 - gatsby-transformer-sqip@0.0.2
 - gatsby@1.9.256

* Add tutorial on creating a source plugin

* Format

* Add extensions to .eslintrc (#5206)

- Add .json or .yaml extension to .eslintrc files

```shell
$ cd ./packages
$ rename 's/.eslintrc/.eslintrc.yaml/' `find . -name .eslintrc`
$ cd ../
$ rename 's/.eslintrc/.eslintrc.json/' `find . -name .eslintrc`
```

- Tweak plopfile.js to add .json extension to examples to be generated

Signed-off-by: Masato Ohba <over.rye@gmail.com>

* Add gatsby-starter-bulma-storybook to the starters list (#5208)

Signed-off-by: Gianni Valdambrini <aleister@develer.com>

* fix: style and typo correction

- Minor style tweaks (e.g. unlinked "pixabay.com" => "Pixabay")
- Typo patrol
- De-British some of the language (my apologies to the letter U)

* Toodle-pip British u

* Adjust heading hierarchy

* Use relative urls for gatsbyjs.org links

* Pull last few sections up a level

* Minor edits and consistency tweaks

* Cleanup example for the createPages API (#5216)

* Update with @shannonbux's edits

* Additional header

* Bumps gatsby-plugin-mailchimp to 2.2.2 bc we updated its API to be more user friendly (#5215)

* Add YAML data file for site showcase (#5227)

* Publish

 - gatsby-image@1.0.49
 - gatsby-link@1.6.42
 - gatsby-plugin-catch-links@1.0.20
 - gatsby-plugin-styletron@2.0.7
 - gatsby-react-router-scroll@1.0.15
 - gatsby@1.9.257

* Update to Gitlab pages deploy (#5243)

* Update to Gitlab pages deploy

Gitlab pages now include a Gatsby template for CI, which makes it a lot easier to add. Have updated the documentation to reflect this.

* Edit

* Update README.md (#5247)

Adding explanation about available option `offsetY` to solve issue #5061
Signed-off-by: Robin Cussol <me@robincussol.com>

* [gatsby-source-contentful] Fix storing new sync token (#5252)

* Add https://emoji.tinder.com/ to showcase (#5257)

* Fix typo (#5241)

* Link to website in contributing.md (#5249)

* Publish

 - gatsby-remark-autolink-headers@1.4.18
 - gatsby-source-contentful@1.3.49
 - gatsby-source-wordpress@2.0.84

* Bump versions of packages that failed to publish earlier

* Publish

 - gatsby-image@1.0.51
 - gatsby-link@1.6.44
 - gatsby-plugin-catch-links@1.0.22
 - gatsby-plugin-styletron@2.0.9
 - gatsby-react-router-scroll@1.0.17
 - gatsby@1.9.259

* Add top padding for tablet masthead (#5266)

* wordpress-source-plugin-tutorial (#5235)

* wordpress-source-plugin-tutorial

Not sure if I got all the code samples formatted correctly.

Still need to edit the index.js page so the <p> tags don't render!!

Then, need a screenshot of the final result without <p> tags!

* removed unnecessary backticks and corrected link to Part 7 of tutorial

* Make links relative

* Use graphql for syntax highlighting + minor copy edits

* Image Tutorial (#5236)

* Image Tutorial

Would be nice to add a screenshot of the finished result.

Eventually, a really cool image tutorial could include GIFs.

* Remove unneeded backticks around code

* Add example gif

* Fix image links

* added Gatsbygram link, fixed assumption spelling

* we --> you

* Added some more edits of my own

wasn't sure whether you wanted lines 153-155 to stay the same

* Changed back to previous lines 149-159

I accidentally deleted necessary stuff in my previous commit, so I'm just starting over

* Edited comments per Mike's suggestions

* Small tweaks

* Add site (#5268)

* readme: Add aQuICK QC landing page site

* readme: Kill old event specific page

* Quick fix for wordpress source plugin tutorial (#5276)

Fragments don't work on Graphiql

* Minor fix on wordpress source plugin tutorial (#5277)

removed typo

* Update wordpress-source-plugin-tutorial.md (#5278)

* add missing underscore to graphiql URL (#5275)

* add missing underscore to graphiql

* Update image-tutorial.md

* Update wordpress-source-plugin-tutorial.md (#5279)

* Update image-tutorial.md (#5281)

* Update source-plugin-tutorial.md (#5283)

* add missing .npmignore and .babelrc to sqip transformer (#5282)

* Publish

 - gatsby-transformer-sqip@0.0.3

* Fix typos in source-plugin-tutorial (#5284)

* Add workshop-in-the-woods.com to the showcase (#5291)

* Update README.md (#5288)

* Update README.md

Missing curly bracket

* formatting

* Fix doc typo (#5294)

*  fix: chang the url of blog in readme 🐛 (#5302)

* feat: ✨ add gatsby-new-blog plugin

* docs: update showcase 📝

* flag importance of plugin order for prism-js vs embed-snippet (#5313)

If gatsby-remark-prism-js is declared before gatsby-remark-embed-snippet, the latter will not pick up the `embed:example.js` syntax because it is looking for an inline-code node and it will have been transformed into a p node by gatsby-remark-prism-js. This needs to be noted as this is far from obvious.

* Add manifest.webmanifest to staticFileGlobs (#5300)

Signed-off-by: Kaue Machado <kaumac@gmail.com>

* Publish

 - gatsby-plugin-offline@1.0.16
 - gatsby-remark-embed-snippet@1.0.22
 - gatsby-source-contentful@1.3.50

* Fix post path comment (#5295)

* Fix post path

* Fix

* Expand docs for custom components (#5315)

* Expand docs for custom components

The docs for custom components only mention defining custom components in the markdown, but don't address one of the most useful aspects - that you can map generic markdown tags/elements to your own components. I've expanded the docs to point this out and added a simple example.

* Typo

* plugin-feed: Note feed xml file is production only (#5305)

Add note that the rss.xml feed is only generated in production.

* Fixing grammar around CSS Modules (#5286)

* Fix broken link to tutorial for building blog (#5273)

I don't know if it's the original article but at least it looks fairly similar

* added develop command options to use custom key and certs (#5056)

* added develop command options to use custom key and certs

* fixed typos in doc

* added condition to make sure both --key-file and --cert-file are present

* - passing https flag results in automatic https certs [devcert]
- --cert-file, --key-file, and --https flags can be used together for custom ssl
- if all flags needed for custom ssl are not present an error is displayed to the user
- if provided --cert-file and --key-file paths are not real files, node gives a rejection
- modified docs to express current behavior

* Add portfolio to the created with gatsby section (#5331)

* Documentation for images in page components #3380 (#4191)

* adding first draft

* adding info about fragments

* cleaning up language

* renaming file, this commit is for issue #3380

* technical edits on working with images in gatsby

* technical edits on working with images in gatsby

* punctuation and verb tense edits

* more punctuation and grammar

* commas

* Add new docs page to sidebar (#5339)

* New issue, feature and question template (#5274)

* Basic template for new issues

* updated issue template

* updated issue template

* Update ISSUE_TEMPLATE.md

* Update ISSUE_TEMPLATE.md

* changed bug report to the new GitHub issue template

* add feature request template

* question template

* fixed title of question and added emojis

* added RFC to question template

* Update bug_report.md

* Update feature_request.md

* Update question.md

* Typo

* Update custom-html.md (#5341)

* Update custom-html.md

grammar corrections

* Revert one change

* Actually revert that one change

* add plugin option examples (#5345)

add plugin option examples

* Remove workshop banner now that workshops have finished (#5338)

* Update url-loader (#5342)

* Update plugins.md

* [gatsby-source-contentful]: Add fallback locale support (#5328)

* Add fallback locale support

* Fix linting

* test: Fix test

* Publish

 - gatsby-cli@1.1.52
 - gatsby-plugin-feed@1.3.22
 - gatsby-source-contentful@1.3.51
 - gatsby-transformer-remark@1.7.41
 - gatsby@1.9.260

* [gatsby-source-wordpress] check if parent exists (#5373)

* [gatsby-source-filesystem] add fs error handling, bump got retry attemps count (#5375)

* [gatsby-source-filesystem] catch fs stream errors

* [gatsby-source-filesystem] bump got retries from default 2 to 5

* normalize reject payload

* Add context to query-runner error log (#5214)

* [www] Prevent image twitching in Chrome when hovering a blog index card (#5396)

* [gatsby-transformer-yaml] Update docs: GraphQL query mismatch (#5402)

GraphQL query references "value" when it should actually reference "character" as per the example output.

* [gatsby-transformer-json] Update docs: outdated Readme examples (#5403)

`{ internal: { type } }` exists but it would actually be "LettersJson" (according to my GraphiQL checks).
Seems better to just remove this, so it at least has parity with gatsby-transformer-yaml readme.

* Add "Six Reasons I Chose Gatsby" blog post (#5369)

* added  "Six Reasons I Chose Gatsby" blog post

* added site to showcase

* updated content based on review comments

* updated Gatsby links to be relative

* Fix for IE10 not loading scripts (#5404)

* Fix for IE10 not loading scripts

* Fixed duplicate declaration.

* Update example config for netlify-cms (#5405)

Added the public_folder attribute to make the assets accessible.

Also added the body field to the collection, so the html attribute of markdownRemark gets filled properly. Figuring out that the field has to be named "body" was a bit cumbersome.

https://www.netlifycms.org/docs/configuration-options/#fields

* Fix regression with prefix paths and gatsby-plugin-manifest (#5406)

as per 69ca247#diff-079fdad4111264c646208511aa18a321 manifest.webmanifest should start with /

it just works (tm) when your site is flat, but when your pages are in sub directory and prefixed, its assumes your manifest files are in the subdirectory, not the root of your site (which might be prefixed).

Fixing reversion

* Remove old comment (#5407)

Code changed in #5404, this comment no longer relevant.

* Add gatsby-starter-modern (#5427)

* Publish

 - gatsby-plugin-manifest@1.0.22
 - gatsby-source-drupal@2.0.38
 - gatsby-source-filesystem@1.5.36
 - gatsby-source-wordpress@2.0.85
 - gatsby-transformer-json@1.0.18
 - gatsby-transformer-yaml@1.5.17
 - gatsby@1.9.261

* Mention in building apps docs page that we use React Router under the hood (#5439)

* Add a how to add search to your website section (#5272)

* Add a how to add search to your website section

* Update adding-search.md

* Update doc-links.yaml

* Update adding-search.md

* Better restructuring

* Update doc-links.yaml

* Update adding-search.md

* Address Changes

* Rewrite docs

* Add the link before the links to stub articles

The ones ending with * are stubs

* Tidy up

* Grammar/punctuation edits and some wording edits

* Adding Headers

* Edits

* More headings

* Minor edits

* Update adding-search.md (#5448)

* regenerate yarn.lock

* temporarily disable stylus tests - need to update both tests and example sites to v2

* fix wrong conflict resolution
  • Loading branch information
pieh authored and m-allanson committed May 17, 2018
1 parent 91d5f4f commit 9b48eab
Show file tree
Hide file tree
Showing 164 changed files with 5,163 additions and 538 deletions.
2 changes: 1 addition & 1 deletion .eslintrc → .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@
{
"files": [
"packages/**/gatsby-browser.js",
"pacakges/gatsby/cache-dir/**/*"
"packages/gatsby/cache-dir/**/*"
],
"env": {
"browser": true
Expand Down
45 changes: 0 additions & 45 deletions .github/ISSUE_TEMPLATE.md

This file was deleted.

43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug Report 🐞
about: Something isn't working as expected? Here is the right place to report.
---

<!--
To make it easier for us to help you — please follow the suggested format below.
Useful Links:
- Documentation: https://www.gatsbyjs.org/docs/
- How to File an Issue: https://www.gatsbyjs.org/docs/how-to-file-an-issue/
Before opening a new issue, please search existing issues https://github.com/gatsbyjs/gatsby/issues
-->

## Description

Describe the issue that you're seeing.

### Steps to reproduce

Clear steps describing how to reproduce the issue.

### Expected result

What should happen?

### Actual result

What happened.

### Environment
* Gatsby version (`npm list gatsby`):
* gatsby-cli version (`gatsby --version`):
* Node.js version:
* Operating System:

### File contents (if changed)
`gatsby-config.js`: N/A <!-- Please use a code block or just leave it as is if wasn't changed -->
`package.json`: N/A <!-- Please use a code block or just leave it as is if wasn't changed -->
`gatsby-node.js`: N/A <!-- Please use a code block or just leave it as is if wasn't changed -->
`gatsby-browser.js`: N/A <!-- Please use a code block or just leave it as is if wasn't changed -->
`gatsby-ssr.js`: N/A <!-- Please use a code block or just leave it as is if wasn't changed -->
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request 💡
about: Suggest a new idea for the project.
---

<!--
To make it easier for us to help you — please follow the suggested format below.
Useful Links:
- Gatsby RFCs: https://github.com/gatsbyjs/rfcs
- How to Contribute: https://www.gatsbyjs.org/docs/how-to-contribute/
- How to File an Issue: https://www.gatsbyjs.org/docs/how-to-file-an-issue/
Before opening a new issue, please search existing issues https://github.com/gatsbyjs/gatsby/issues
-->

## Summary

Brief explanation of the feature.

### Basic example

If the proposal involves a new or changed API, include a basic code example. Omit this section if it's not applicable.

### Motivation

Why are we doing this? What use cases does it support? What is the expected outcome?
19 changes: 19 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Question 🤔
about: Usage question or discussion about Gatsby.
---

<!--
To make it easier for us to help you, please include as much useful information as possible.
Useful Links:
- Documentation: https://www.gatsbyjs.org/docs/
Gatsby has several community support channels, try asking your question on:
- Discord: https://discord.gg/0ZcbPKXt5bVoxkfV
- Spectrum: https://spectrum.chat/gatsby-js
- Twitter: https://twitter.com/gatsbyjs
Before opening a new issue, please search existing issues https://github.com/gatsbyjs/gatsby/issues
-->
158 changes: 2 additions & 156 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,157 +1,3 @@
---
title: How to Contribute
---
## How to Contribute

## Contributing

We want contributing to Gatsby to be fun, enjoyable, and educational for anyone and everyone. Contributions go far beyond pull requests and commits; we are thrilled to receive a variety of other contributions including the following:

* Blogging, speaking about, or creating tutorials about one of Gatsby's many features. Mention @gatsbyjs on Twitter and/or email shannon [at] gatsbyjs [dot] com so we can give pointers and tips (if you want them :) and help you spread the word. Please add your blog posts and videos of talks to our [Awesome Gatsby](/docs/awesome-gatsby/) page.
* [Submit new feature ideas through an RFC](/blog/2018-04-06-introducing-gatsby-rfc-process/)
* Submitting new documentation; titles in _italics_ on gatsbyjs.org are stubs and need contributions
* Tweeting about things you build with @gatsbyjs (make sure to @ mention us!)
* Submitting documentation updates, enhancements, designs, or bugfixes
* Submitting spelling or grammar fixes
* Adding unit or functional tests
* Triaging [GitHub issues](https://github.com/gatsbyjs/gatsby/issues) -- especially determining whether an issue still persists or is reproducible
* [Reporting bugs or issues](/docs/how-to-file-an-issue/)
* Searching for Gatsby on Discord or Spectrum and helping someone else who needs help
* Teaching others how to contribute to Gatsby's repo!

If you are worried or don't know where to start, you can always reach out to Shannon Soper(@shannonb_ux) on Twitter or simply submit an issue and a maintainer can help give you guidance!

Looking to speak about Gatsby? We'd love to review your talk abstract/CFP! You can email it to shannon [at] gatsbyjs [dot] com, and we can give pointers or tips!!!

### Creating your own plugins and loaders

If you create a loader or plugin, we would <3 for you to open source it and put it on npm. For more information on creating custom plugins, please see the documentation for [plugins](/docs/plugins/) and the [API specification](/docs/api-specification/).

### Contributing to the repo

Gatsby uses a "monorepo" pattern to manage its many dependencies and relies on
lerna and yarn to configure the repository for active development.

You can install the latest version of Gatsby by following these steps:

* Clone the repo, navigate to its directory.
* ensure you have the latest version of yarn installed (>= 1.0.2)
https://yarnpkg.com/en/docs/install
* Install dependencies using `yarn run bootstrap` in the root of the repo.

The usual contributing steps are:

* Fork the [official repository](https://github.com/gatsbyjs/gatsby).
* Clone your fork: git clone `git@github.com:<your-username>/gatsby.git`
* Setup up repo and install dependencies: `yarn run bootstrap`
* Make sure tests are passing for you: `yarn test`
* Create a topic branch: `git checkout -b topics/new-feature-name`
* Run `yarn run watch` from the root of the repo to watch for changes to packages' source code and compile these changes on-the-fly as you work. Note that the watch command can be resource intensive. To limit it to the packages you're working on, add a scope flag, like `yarn run watch --scope={gatsby,gatsby-cli}`. To watch just one package, run `yarn run watch --scope=gatsby`.
* Install [gatsby-dev-cli](/packages/gatsby-dev-cli/) globally: `yarn global add gatsby-dev-cli`
* Run `yarn install` in each of the sites you're testing.
* For each of your Gatsby test sites, run the `gatsby-dev` command there to copy
the built files from your cloned copy of Gatsby. It'll watch for your changes
to Gatsby packages and copy them into the site. For more detailed instructions
see the [gatsby-dev-cli README](/packages/gatsby-dev-cli/)
* Add tests and code for your changes.
* Once you're done, make sure all tests still pass: `yarn test`
* Commit with a ["Signed-off-by"](#developer-certificate-of-origin) line appended
to your commit message and push to your fork.
* Create a pull request from your branch.

### Contributing to the documentation.

Gatsby, unsurprisingly, uses Gatsby for its documentation website.

If you want to add/modify any Gatsby documentation, go to the
[docs folder on GitHub](https://github.com/gatsbyjs/gatsby/tree/master/docs) and
use the file editor to edit and then preview your changes. GitHub then allows
you to commit the change and raise a PR right in the UI. This is the _easiest_
way you can contribute to the project!

However, if you want to make more changes to the website, that is, change
layouts, add sections/pages, follow the steps below. You can then spin up your
own instance of the Gatsby website and make/preview your changes before raising
a pull request.

* Clone the repo and navigate to `/www`
* Run `yarn` to install all of the website's dependencies.
* Run `gatsby develop` to preview the website in `http://localhost:8000`
* The Markdown files for the documentation live in `/docs` folder. Make
additions or modifications here.
* Make sure to double check your grammar and capitalise correctly.
* Commit with a ["Signed-off-by"](#developer-certificate-of-origin) line appended
to your commit message and push to your fork.
* Create a pull request from your branch.

### Developer Certificate of Origin

The Gatsby repository enforces the
[Developer Certificate of Origin](https://developercertificate.org/) (DCO) on
Pull Requests. It requires all commit messages to contain the `Signed-off-by`
line with an email address that matches the commit author.

Git has a `-s` (or longer `--signoff`) command line option to append this
automatically to your commit message:

```shell
$ git commit -s -m 'This is my commit message'
```

If you've already created a Pull Request and notice that the DCO check is failing, you
can use this command to append a signoff message to your commits:

```shell
$ git rebase --signoff
```

or amend your last commit if you have a single commit in your Pull Request:

```shell
$ git commit --amend -s
```

## Development tools

### Redux devtools

Gatsby uses Redux for managing state during development and building. It's often
helpful to see the flow of actions and built-up state for a site you're working
on or if adding new functionality to core. We leverage
[Remote Redux Devtools](https://github.com/zalmoxisus/remote-redux-devtools) and
[RemoteDev Server](https://github.com/zalmoxisus/remotedev-server) to give you use the Redux
devtools extension for debugging Gatsby.

To use this, first install
[redux-devtools-extension](https://github.com/zalmoxisus/redux-devtools-extension)
in your browser. Then in your Gatsby repo, run `npm run remotedev`. Then in your
site directory run `REDUX_DEVTOOLS=true gatsby develop`. Depending on your
operating system and shell, you may need to modify how you set the
`REDUX_DEVTOOLS` environment variable.

At this point, your site will be sending Redux actions and state to the remote
server.

To connect to this, you need to setup the devtools extension to talk to the
remote server.

First open the remote devtools.

![how to open the redux remote devtools extension](./images/open-remote-dev-tools.png)

Then click settings along the bottom menu and set the host and port.

![how to set the host/port for the remote devtools extension to connect to Gatsby](./images/remote-dev-settings.png)

After this, the devtools extension _should_ connect to the remote server and
you'll see actions start showing up.

![gatsby redux remote devtools](./images/running-redux-devtools.png)

**Warning!! Lots of buginess**. While having this available is extremely
helpful, this setup is very buggy and fragile. There is a memory leak in the
extension that's triggered it seems every time you restart the Gatsby
development server. Also the extension often, for no apparent reason, just won't
show any actions from the remote server. It'll also often freeze up. The best
solution seems to just be turning everything off and on again. Fixing up these
tools would be very helpful for us and many others using these tools if someone
wants to take this on!
For information related to contributing to Gatsby, please check out the [How to Contribute](https://www.gatsbyjs.org/docs/how-to-contribute/) section of the documentation at the Gatsby site.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Websites built with Gatsby:
* [The freeCodeCamp Guide](https://guide.freecodecamp.org)
([source](https://github.com/freeCodeCamp/guides))
* [Storybook](https://storybook.js.org) ([source](https://github.com/storybooks/storybook))
* [Learn Storybook](https://learnstorybook.com) ([source](https://github.com/hichroma/learnstorybook.com))
* [FloydHub's Blog](https://blog.floydhub.com)
* [mParticle's Documentation](https://docs.mparticle.com)
* [Segment's Blog](https://segment.com/blog/)
Expand Down Expand Up @@ -164,7 +165,7 @@ Websites built with Gatsby:
* [Portfolio / Blog of Preston Richey](https://prestonrichey.com/) ([source](https://github.com/prichey/prestonrichey.com))
* [Beach Hut Poole](https://www.beachhutpoole.co.uk/)
* [In Sowerby Bridge](https://www.insowerbybridge.co.uk/)
* [枫上雾棋的日志](https://fengshangwuqi.github.io/fswq-blog/)
* [枫上雾棋的日志](https://fengshangwuqi.github.io/)
* [Juliette Pretot's Portfolio](https://juliette.sh)
* [Théâtres Parisiens](http://theatres-parisiens.fr/) ([source](https://github.com/phacks/theatres-parisiens))
* [Jia Hao's Website / Blog](https://jiahao.codes/) ([source](https://github.com/jiahaog/jiahao.codes))
Expand Down Expand Up @@ -194,8 +195,6 @@ Websites built with Gatsby:
* [WebGazer](https://www.webgazer.io)
* [Joe Seifi's Blog](http://seifi.org)
* [Bartosz Dominiak Blog/Portfolio](http://www.bartoszdominiak.com/) ([source](https://github.com/bartdominiak/blog))
* [HBTU MUN 2018](https://hbtumun18.netlify.com/)
([source](https://github.com/HaoZeke/hbtuMun18))
* [The Audacious Project](https://audaciousproject.org/)
* [upGizmo](https://www.upgizmo.com/)
* [The Bastion Bot](https://bastionbot.org/ "The Bastion Bot")
Expand All @@ -204,6 +203,18 @@ Websites built with Gatsby:
* [F1 Vision](https://f1vision.com/)
* [GraphQL College](https://graphql.college) ([source](https://github.com/GraphQLCollege/graphql-college))
* [Hyunwoo Kim - Blog/Portfolio](https://devhalloween.com) ([source](https://github.com/khw1031/dev-blog))
* [Abinav Seelan - Personal Website](https://abinavseelan.com) ([source](https://github.com/abinavseelan/abinavseelan.com))
* [Dovetail](https://dovetailapp.com)
* [Bart van der Waerden Blog](http://bartvanderwaerden.com/) ([source](https://github.com/BartvdWaerden/BartvdWaerden.github.io))
* [Canella Riccardo - Portfolio](https://canellariccardo.it) ([source](https://github.com/thecreazy/canellariccardo.it))
* [Eviction Free NYC!](https://www.evictionfreenyc.org/) ([source](https://github.com/JustFixNYC/eviction-free-nyc))
* [Rafael Belliard's Portfolio](https://rafael.do) ([source](https://github.com/rebelliard/rebelliard.github.io))
* [Tinder Interracial Couple Emoji Project](https://emoji.tinder.com/)
* [aQuICK](https://aquick.review/)
([source](https://github.com/aQuICK-Review/aQuick))
* [Workshop In The Woods](https://www.workshop-in-the-woods.com/) ([source](https://github.com/ryanwiemer/workshop))
* [Steven Koerts - Portfolio](http://stevenkoerts.nl/)([source](https://github.com/Steven24K/Steven24K.github.io))
* [Ray Gesualdo - Personal Website](http://www.raygesualdo.com/) ([source](https://github.com/raygesualdo/raygesualdo.com))

## Docs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ From October 2017 to February 2018, I conducted over 60 interviews with Gatsby u

## Jobs to be done

After compiling data from the interviews, I drew what’s called an “empathy map” to put myself in the shoes of Gatsby users. This map describes what a Gatsby users usually experienced when searching for plugins.
After compiling data from the interviews, I drew what’s called an “empathy map” to put myself in the shoes of Gatsby users. This map describes what Gatsby users usually experienced when searching for plugins.

![Empathy map](empathy-map.png)

Expand Down
Loading

0 comments on commit 9b48eab

Please sign in to comment.