Skip to content

Commit

Permalink
chore(docs): add contributing examples note; move schema customizatio…
Browse files Browse the repository at this point in the history
…n, etc. (gatsbyjs#14445)

* update Gatsby internals doc title for continuity

* add note about example sites

In reference to gatsbyjs#14291

* move schema customization docs to API section
  • Loading branch information
Marcy Sutton authored May 31, 2019
1 parent 126b8e5 commit 159d1d5
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
7 changes: 7 additions & 0 deletions docs/contributing/code-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ On this page:
- [Repo setup](#repo-setup)
- [Creating your own plugins and loaders](#creating-your-own-plugins-and-loaders)
- [Making changes to the starter Library](#making-changes-to-the-starter-library)
- [Contributing example sites](#contributing-example-sites)
- [Using Docker to set up test environments](#using-docker-to-set-up-test-environments)
- [Development tools](#development-tools)

Expand Down Expand Up @@ -40,6 +41,12 @@ GITHUB_API_TOKEN=YOUR_TOKEN_HERE

The `.env.development` file is ignored by git. Your token should never be committed.

## Contributing example sites

Gatsby's policy is that "Using" example sites (like those in the [examples part of the repo](https://github.com/gatsbyjs/gatsby/tree/master/examples)) should only be around plugins that are maintained by the core team as it's hard to keep things up to date otherwise.

To contribute example sites, it is recommended to create your own GitHub repo and link to it from your source plugin, etc.

## Using Docker to set up test environments

With all of the possible Gatsby integrations, it might help to spin up a Docker container with the software application you need to test. This makes installation a breeze, so you can focus less on getting set up and more on the integration details that matter to you.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/gatsby-internals.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Gatsby Internals
title: Behind the Scenes with Gatsby Internals
---

Curious how Gatsby works under the hood? The pages in this section describe how a Gatsby build works from an internal code/architecture point of view. It should be useful for anyone who needs to work on the internals of Gatsby, or for those who are simply curious how it all works, or perhaps you're a plugin author and need to understand how core works to track down a bug? Come one, come all!
Expand Down
4 changes: 2 additions & 2 deletions www/src/data/sidebars/doc-links.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,6 @@
link: /docs/adding-markdown-pages/
- title: Adding a List of Markdown Blog Posts
link: /docs/adding-a-list-of-markdown-blog-posts/
- title: Customizing the GraphQL Schema
link: /docs/schema-customization/
- title: Plugins
link: /docs/plugins/
items:
Expand Down Expand Up @@ -358,6 +356,8 @@
link: /docs/node-model/
- title: Node Interface
link: /docs/node-interface/
- title: Customizing the GraphQL Schema
link: /docs/schema-customization/
- title: API Philosophy
link: /docs/api-specification/
- title: Releases & Migration
Expand Down

0 comments on commit 159d1d5

Please sign in to comment.