From 159d1d5919fd9ed48e0b315e7262d2f782287d35 Mon Sep 17 00:00:00 2001 From: Marcy Sutton Date: Fri, 31 May 2019 11:07:17 -0700 Subject: [PATCH] chore(docs): add contributing examples note; move schema customization, etc. (#14445) * update Gatsby internals doc title for continuity * add note about example sites In reference to https://github.com/gatsbyjs/gatsby/pull/14291 * move schema customization docs to API section --- docs/contributing/code-contributions.md | 7 +++++++ docs/docs/gatsby-internals.md | 2 +- www/src/data/sidebars/doc-links.yaml | 4 ++-- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/contributing/code-contributions.md b/docs/contributing/code-contributions.md index 6dcf423e88572..7d01b0fc105ea 100644 --- a/docs/contributing/code-contributions.md +++ b/docs/contributing/code-contributions.md @@ -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) @@ -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. diff --git a/docs/docs/gatsby-internals.md b/docs/docs/gatsby-internals.md index 1a80ea8270cd5..1ec0492ffd6f5 100644 --- a/docs/docs/gatsby-internals.md +++ b/docs/docs/gatsby-internals.md @@ -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! diff --git a/www/src/data/sidebars/doc-links.yaml b/www/src/data/sidebars/doc-links.yaml index 468173468359d..095b9101b4a2e 100644 --- a/www/src/data/sidebars/doc-links.yaml +++ b/www/src/data/sidebars/doc-links.yaml @@ -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: @@ -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