Skip to content

Commit

Permalink
[SYNC] Sync with gatsbyjs/gatsby (#3)
Browse files Browse the repository at this point in the history
* Update from gatsbyjs/gatsby

* sync with monorepo gatsbyjs/gatsby@5d3f6ef - Update from gatsbyjs/gatsby

* sync with monorepo gatsbyjs/gatsby@1acac83 - update a few reference guide overview pages (#19296)

* sync with monorepo gatsbyjs/gatsby@ac5af97 - docs: adding rehydration doc and updates to building apps over… (#19214)

* sync with monorepo gatsbyjs/gatsby@7447d10 - Fix linting for new version of Prettier

* sync with monorepo gatsbyjs/gatsby@149f0d2 - docs: styles folder name incorrect (#19405)

the `/styles/` from the docs about `src/styles/global.css` is written as
`/styles/styles/`

* sync with monorepo gatsbyjs/gatsby@f488d4a - Update gatsby-style-guide.md (#19404)

Changes link to Hemingway App from `https://www.hemingwayapp.com/` to `https://hemingwayapp.com/` because `https://www.hemingwayapp.com/` has an invalid SSL certificate and is flagged as a security risk.

* sync with monorepo gatsbyjs/gatsby@eb165e3 - Add instructions for changing deeplinks when editing headings (#19186)

* sync with monorepo gatsbyjs/gatsby@702f8e1 - Add note how to enable eslint-loader with custom config (#19399)

* sync with monorepo gatsbyjs/gatsby@5bbf527 - docs(mdx): add caveat on graphql query export (#19366)

* sync with monorepo gatsbyjs/gatsby@16adf60 - chore(docs): Update awesome-gatsby (#19315)

* sync with monorepo gatsbyjs/gatsby@2b48c10 - docs(gatsby): html.js docs for themes (#19211)

* docs(gatsby): html.js docs for themes

#19181

* docs(html): html.js custom placement

* docs(htm): Update docs/docs/custom-html.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* sync with monorepo gatsbyjs/gatsby@67f9740 - [docs] Fix expected directory tree in _Shadowing other themes_ (#19140)

* sync with monorepo gatsbyjs/gatsby@ce0c7b4 - docs: consistent terminology for hydration (#19449)

* sync with monorepo gatsbyjs/gatsby@5eef712 - docs: add better source plugin documentation (#19413)

* add better source plugin documentation

* chore: format

* Apply suggestions from code review

* sync with monorepo gatsbyjs/gatsby@9e01476 - Update Code of Conduct to include divisive

* sync with monorepo gatsbyjs/gatsby@72128a4 - chore(docs): Add note about file extensions (#19464)

* sync with monorepo gatsbyjs/gatsby@52be765 - fix(gatsby): Re-use plugin resolution logic for theme dir resolution (#19470)

* sync with monorepo gatsbyjs/gatsby@9047cad - chore(docs): link to gatsby-plugin-catch-links in gatsby link… (#19424)

* sync with monorepo gatsbyjs/gatsby@4db2ff1 - chore(docs): Add documentation for tailwindcss support (#17747)

* Added documentation for tailwindcss support

Additionally I fixed some highlight and intendation mistakes

* Fixed code highlighting

Inside the code sample was SCSS code instead of Sass. So, I changed the file extenstion into `scss`.

* chore: format

* consistent code formatting

* removed tailwindcss instructions

* added sass implementation of tailwind css

* consistent use of tailwindcss and Tailwind CSS

* imcorporate requested changes

Co-authored-by: GatsbyJS Bot <mathews.kyle+gatsbybot@gmail.com>
Co-authored-by: Lennart <lekoarts@gmail.com>

* sync with monorepo gatsbyjs/gatsby@337bbd0 - Add hint how to disable ESLint (#19171)

* Add hint how to disable ESLint #19170

* Run prettier

* Apply code review suggestion for docs/docs/eslint.md

Co-Authored-By: LB <laurie@gatsbyjs.com>

* Run prettier

* Add explanatory paragraph back

* chore: format

* sync with monorepo gatsbyjs/gatsby@9d37452 - Fix spelling mistake in eCommerce tutorial index (#19494)

* sync with monorepo gatsbyjs/gatsby@2aae4e6 - chore(docs): Add new language in transalation list (#19467)

* Add Gujarati, French, Mongolian langulage to new transalation list

* Add the entries alphabetically sorted by the language code

* sync with monorepo gatsbyjs/gatsby@0cad243 - Tutorial improvements (#19500)

* Added F12 key hint for devtools

* Add import headers for full-copy-paste

This brings the code examples in line with the other examples, which can be fully copy-pasted into the file without error.

* sync with monorepo gatsbyjs/gatsby@75f411d - Add Traditional chinese language to translation list in doc (#19498)

* sync with monorepo gatsbyjs/gatsby@58a627e - chore(docs): Adds two key steps on building ecommerce sites wi… (#18669)

* resolves #14598

Adds a reference guide on how to upgrade Gatsby and its dependencies

* Fixed typos and added related content

* Fixed additional typos

* Fixed additional typos, one with the name of the file, added links for the doc-links.yaml file, escaped < and > characters in markdown thata were causing some errors

* Updated title based on @marcysutton suggestions

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Solves suggested changes such as modifying links for relative urls, removing yarn instructions and alignments to Gatsby style guide

* Apply additional suggestions

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Little typo with the npm-force-resolutions package name is fixed

* Added two additional steps for the tutorial on how to build ecommer sites with Stripe that were required by stripe for the example to work

* Added missing screenshot files

* Removed intstructions from the old Stripe UI

* Removes the now unused images and integrates suggestions from gatsby learning

* Changed integration to function when referring to the `redirectToCheckout` function

Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* Rewrote the requirements to use this integration, changed pronouns, fixed typos, changed quotes

* Added missing screenshot file

* Apply suggestions from code review

Co-Authored-By: LB <laurie@gatsbyjs.com>

* Apply suggestions from code review

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* sync with monorepo gatsbyjs/gatsby@21023d5 - docs: Importing JSON files correctly outside GraphQL (#17061)

Co-authored-by: Ward Peeters <ward@coding-tech.com>
Co-authored-by: GatsbyJS Bot <mathews.kyle+gatsbybot@gmail.com>

* sync with monorepo gatsbyjs/gatsby@70f03f1 - chore(docs): Add Vietnamese language in transalation list (#19539)

* sync with monorepo gatsbyjs/gatsby@8882caf - Update second code block to include title field which is missing (#19542)

title field is missing from second block which makes the code confusing when printing the title within H1 but title is not included in fields queried via GraphQL statement.

* sync with monorepo gatsbyjs/gatsby@037006b - chore: add gatsby-templates.io to awesome-gatsby-resources.md (#19503)

* sync with monorepo gatsbyjs/gatsby@c369fdd - Link "Gatsby Cloud" to https://www.gatsbyjs.com/

* sync with monorepo gatsbyjs/gatsby@c980634 - Fix grammatical error in preparing-for-deployment (#19566)

* sync with monorepo gatsbyjs/gatsby@aac2b97 - Update why-contribute-to-gatsby.md file (#19560)

* sync with monorepo gatsbyjs/gatsby@67d8b6b - docs: Renaming of Kentico Kontent (#19114)

* Changes for renaming of Kentico Kontent

* fix linting problem

* add redirect for renamed tutorial

* Add additional redirect

* Update link in blog post

* Remove old blog post

* Add renamed starter back in

* Change npm for yarn

* Fix location of kontent starter

* chore: format

* sync with monorepo gatsbyjs/gatsby@20afc1b - docs: remove TODOs from Static vs Normal Queries to focus more on internals (#19219)

* remove TODOs and focus the doc more on internals

* Apply suggestions from code review

Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* Apply suggestions from code review

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* updates to remove implementation details and clarify more concepts

* add one more example to show differences

* Apply suggestions from code review

Co-Authored-By: LB <barth.laurie@gmail.com>

* Update docs/docs/static-vs-normal-queries.md

Co-Authored-By: LB <barth.laurie@gmail.com>

* sync with monorepo gatsbyjs/gatsby@26c1b65 - Fix typo in "Extensions and directives" section in schema-cust… (#19625)

* sync with monorepo gatsbyjs/gatsby@e1930af - [docs] Add local plugins to "Building Themes" (#19330)

* sync with monorepo gatsbyjs/gatsby@b4b5c32 - docs: add detail on server configurations for client side rout… (#19554)

* add more detail on server configurations

* fix heading

* Update client-only-routes-and-user-authentication.md

* chore: format

* sync with monorepo gatsbyjs/gatsby@1cc2045 - chore(docs): Fix typo in wordpress-source-plugin-tutorial.md (#19629)

Correct the spelling in the path

* sync with monorepo gatsbyjs/gatsby@617295a - chore(docs): Fix case of Gatsby, Strapi, Bootstrap and WordPress (#19626)

* sync with monorepo gatsbyjs/gatsby@ed105ec - Remove creator showcase (#19495)

* sync with monorepo gatsbyjs/gatsby@b549007 - fix(docs): Incorrect directory reference in recipe snippet (#19650)

* sync with monorepo gatsbyjs/gatsby@328f2e6 - chore(docs): updates for old maintainer meeting (#19660)

* sync with monorepo gatsbyjs/gatsby@ed5f991 - docs: gatsby for apps - auth and client only routes (#19551)

* initial improvements

* update example and add explanations for client only routes

* add overview of auth

* more auth example code

* finishing touches to connect docs and smooth out overall flow

* chore: format

* chore: format

* Apply suggestions from code review

Co-Authored-By: LB <barth.laurie@gmail.com>
Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* added section on differences and fixed some hanging sentences

* Update docs/docs/building-a-site-with-authentication.md

Co-Authored-By: LB <barth.laurie@gmail.com>

* update to fall in line with new content on configuring server for client only routes

* chore: format

* Update docs/docs/client-only-routes-and-user-authentication.md

Co-Authored-By: LB <barth.laurie@gmail.com>

* sync with monorepo gatsbyjs/gatsby@a6d9655 - Update sites.yml (#19672)

* sync with monorepo gatsbyjs/gatsby@baea439 - Added information about deployment to Microsoft IIS (#19371)

* Added information about deployment to Microsoft Internet Information Server (IIS) to the docs; especially with regards to caching.

* Update docs/docs/deploying-to-iis.md

Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* Converted tabs to spaces to make formatting of XML consistent.

* Update docs/docs/deploying-to-iis.md

Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* Added deploying-to-iis to doc-links.yaml.

* chore: format

* sync with monorepo gatsbyjs/gatsby@e81c45c - Include gatsby-remark-images in RootConfig.Plugins array of code-copy section in docs. (#19671)

* [docs/mdx-plugin/gatsby-remark-images]
including options.plugins entry

* [docs/mdx-plugin] fixing lint error

* [docs/mdx-plugin/gatsby-remark-images__config-update]

Adding gatsby-remark-images to root plugins array

* [docs/mdx-plugin/gatsby-remark-images]
Responding to change request:

Adding detail to sentence above code section block.

* sync with monorepo gatsbyjs/gatsby@f86d8c6 - Fix and clarify Ghost sourcing page (#19411)

* Fix and clarify Ghost sourcing page

* Update docs/docs/sourcing-from-ghost.md

Co-Authored-By: Mikhail Novikov <freiksenet@gmail.com>

* sync with monorepo gatsbyjs/gatsby@7f9d5bb - fix(gatsby-plugin-sharp): fix progressbar & caching layer (#19717)

* sync with monorepo gatsbyjs/gatsby@ca4a65c - docs: guide for porting an html site to gatsby (#18609)

* docs: guide for porting part of a html site to gatsby

* fix: add missing normalize.css file to trees, build sentence rewrite

* fix: change links to be relative paths

* Apply suggestions from code review

Co-Authored-By: Kyle Gill <kylerobertgill@gmail.com>

* Apply suggestions from @gillkyle code review

* Clearer and Consistenter(heh) prefix descriptions

* format is aggressive about wrapping here, switching to start/end marks!

* bracket typo, square the curl

* Apply suggestions from code review

Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* parting more ports and the complete Gatsby section, per @muescha suggestion

* Update docs/docs/porting-part-of-a-html-site-to-gatsby.md

Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* Make page more general, for porting part and the whole

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Apply suggestions from code review

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Style guide: less we more you

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Apply suggestions from code review

- Briefly explain JSX and add in some mentions.
- Expand and clarify JavaScript / JSX passages.

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Review: Clarify tooling and building points.

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* condense why section and link off to core philosophy

* expand on isolation -> integration in porting process

* add file example for adjusting Link tags in porting more parts

* fix heading structure: add h1 on each page and make logo a styled anchor

* change name to match new title

* update sidebar and breadcrumb titles

* remove assetPrefix from example project, add link as note

* restructure for full html site port, with note for prefix options

* fix out of date directory name

* correct contradicting sentence about not changing copied over html markup

* expand opening to position guide relative to main tutorial

* Apply suggestions from code review

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* fix gatsby-site path roots

* Apply suggestion from code review - gatsby serve tip

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* add partial porting note to introduction and hosting section

* consistent flag --

* sync with monorepo gatsbyjs/gatsby@613304c - swap  broken link (#19747)

* swap  broken link

* Update broken link

* sync with monorepo gatsbyjs/gatsby@2a8dd66 - Update blog-and-website-contributions.md (#19756)

* Update blog-and-website-contributions.md

Corrected few of the Grammatical and spelling errors.

* Update docs/contributing/blog-and-website-contributions.md

* Update docs/contributing/blog-and-website-contributions.md

* sync with monorepo gatsbyjs/gatsby@c120b1e - docs(setting-up-your-local-dev-environment): beautify some parts (#19349)

* Update setting-up-your-local-dev-environment.md

* capitals for Node

* add help link to fork

* fix with prettier (#19365)

* Update docs/contributing/setting-up-your-local-dev-environment.md

Co-Authored-By: LB <barth.laurie@gmail.com>

* Update docs/contributing/setting-up-your-local-dev-environment.md

Co-Authored-By: LB <barth.laurie@gmail.com>

* add github help pages about sync

* removed pull app, fixed Github->GitHub

* removed obsolete headline

* sync with monorepo gatsbyjs/gatsby@5dc665f - fix(docs): 404 on docs/modifying-a-starter (#19824)

* sync with monorepo gatsbyjs/gatsby@c65f112 - fix(blog): 404 on docs/migrating-from-v1-to-v2.md (#19826)

* sync with monorepo gatsbyjs/gatsby@0264f27 - fix(docs): link not match text in docs/tutorial/wordpress-sour… (#19828)

* sync with monorepo gatsbyjs/gatsby@2e50fab - fix(doc): 404 on docs/headless-cms (#19822)

* chore(doc): 404 on /docs/headless-cms

* chore: format

Co-authored-by: GatsbyJS Bot <mathews.kyle+gatsbybot@gmail.com>

* sync with monorepo gatsbyjs/gatsby@e0c1618 - Update plugin authoring guide per style guide (#19787)

* update plugin authoring guide per style guide

Adds more explanations to terminology, as some readers may not be familiar with the concepts

* Apply suggestions from code review

Co-Authored-By: LB <barth.laurie@gmail.com>

* sync with monorepo gatsbyjs/gatsby@7b814f8 - fix(docs): fix 404 links (#19853)

* fix link in adding-react-components.md

* fix link to twitter gill kyle

* remove link to not existing GIPHY

* changed twitter handle ( https://www.katiefujihara.com/ )

* removed non existing user at twitter @fernandopoumian - can not find a new one :(

* fix wrong link to react-rehydration -> react-hyadration

* reactfaq.site is abandoned ( timarney/react-faq#39 )

* fixed link for gatsby-starter-theme-workspace

* fixed link for gatsby-theme-blog and gatsby-theme-notes

* fixed link for rfcs 0004-native-graphql-source

* fixed link for octoverse.github.com/#top-languages

* fixed link for gatsby-theme-apollo-docs project-config-panel.mdx

* fixed link for github.com/nicholaswyoung

Co-authored-by: Muescha <>

* sync with monorepo gatsbyjs/gatsby@c125ec2 - chore(docs): Add reference to MDX blog post to main docs (#19804)

Co-authored-by: Laurie Barth <laurie@LauriesrkLaptop.fios-router.home>

* sync with monorepo gatsbyjs/gatsby@da20db9 - fix(docs): fixed images links to use always ./images (#19875)

Co-authored-by: Muescha <>

* sync with monorepo gatsbyjs/gatsby@f2bfeda - chore(docs): Minor grammar fix (#19884)

* sync with monorepo gatsbyjs/gatsby@10663d8 - chore(docs): Minor grammar fix (#19893)

* sync with monorepo gatsbyjs/gatsby@d81605b - Rename Routing Doc and remove duplicate stub (#19918)

* Rename Routing Doc and remove duplicate stub

* add redirect

* sync with monorepo gatsbyjs/gatsby@ea8147c - Update Routing docs main page (#19700)

* Update routing main docs page

* Update docs/docs/routing.md

Co-Authored-By: Sidhartha Chatterjee <me@sidharthachatterjee.com>

* Update docs/docs/routing.md

Co-Authored-By: Kyle Gill <kylerobertgill@gmail.com>

* Update docs/docs/routing.md

* Update docs/docs/routing.md

Co-Authored-By: Kyle Gill <kylerobertgill@gmail.com>

* Update docs/docs/routing.md

Co-Authored-By: Kyle Gill <kylerobertgill@gmail.com>

* Update docs/docs/routing.md

* Prefetching is explained elsewhere. We should change the structure of the docs and point to the content inside the main routing landing page.

* Update docs/docs/routing.md

Co-Authored-By: Michael <184316+muescha@users.noreply.github.com>

* Update docs/docs/routing.md

* Update docs/docs/routing.md

* Update docs/docs/routing.md

* Feedback from conversation with Brittney

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* Update docs/docs/routing.md

Co-Authored-By: Marcy Sutton <marcy@gatsbyjs.com>

* chore: format

* sync with monorepo gatsbyjs/gatsby@7c34e69 - update(docs): mark more Gatsby internal docs for update (#19848)

* update(docs): mark Gatsby internal docs for update

* update(docs): mark Gatsby internal docs for update

* Update docs/docs/node-tracking.md

Co-Authored-By: Aisha Blake <aisha.g.blake@gmail.com>

* Update docs/docs/query-behind-the-scenes.md

Co-Authored-By: Aisha Blake <aisha.g.blake@gmail.com>

* sync with monorepo gatsbyjs/gatsby@0c44d22 - chore(docs): Add sourcing-from-forestry doc page (#18426)

* Add sourcing-from-forestry doc page; Sort headless-cms table to be alphabetical

* Fix formatting for linter

* Revert table sorting; Add Forestry to table

* Add requested changes

* Update sourcing-from-forestry page; Run prettier

* Update sourcing-from-forestry page to include development workflow

* Run format script

* Revert "Run format script"

This reverts commit 5c01c04d6cda4a4ba335ea0180c4b42bbe974592.

Revert prettier edits

* Remove Netlify CMS reference in sourcing-from-forestry page

* Update docs/docs/sourcing-from-forestry.md

Co-Authored-By: LB <laurie@gatsbyjs.com>

* chore: format
  • Loading branch information
MichaelDeBoey committed Dec 5, 2019
1 parent 6b401cf commit 5f730fe
Show file tree
Hide file tree
Showing 79 changed files with 1,883 additions and 612 deletions.
72 changes: 32 additions & 40 deletions docs/contributing/blog-and-website-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,49 +12,41 @@ Here are some things to keep in mind when deciding where to contribute to Gatsby

## Contributing to the blog

Note: Before adding a blog post, ensure you have approval from a member of the Gatsby team. You should [open an issue](https://github.com/gatsbyjs/gatsby/issues/new/choose) or contact [@gatsbyjs on Twitter](https://twitter.com/gatsbyjs) before opening a PR with your blog post. Check out past blog posts for examples of posted content.

To add a new blog post to the gatsbyjs.org blog:

- Clone [the Gatsby repo](https://github.com/gatsbyjs/gatsby/) and navigate to `/www`.
- Run `yarn` to install all of the website's dependencies. ([Why Yarn?](/contributing/setting-up-your-local-dev-environment#using-yarn))
- Run `npm run develop` to preview the blog at `http://localhost:8000/blog`.
- The content for the blog lives in the `/docs/blog` folder. Make additions or modifications here.
- Add your avatar image to `/docs/blog/avatars`.
- Add your name to `/docs/blog/author.yaml`.
- Add a new folder following the pattern `/docs/blog/yyyy-mm-dd-title`. Within this newly created folder, add an `index.md` file.
- Add `title`, `date`, `author`, `excerpt`, and `tags` to the frontmatter of your `index.md`. You can [view existing tags](/blog/tags/), or [add a new one](https://github.com/gatsbyjs/gatsby/blob/master/www/src/data/tags-docs.js) if you feel your tag merits being its own tag, though we encourage you to use existing tags.
- If you are cross posting your post, you can add `canonicalLink` for SEO benefits. You can check the other blog posts in `/docs/blog` for examples.
- If your blog post contains images, add them to your blog post folder and reference them in your post's `index.md`.
- Ensure any links to gatsbyjs.org are relative links - `/contributing/how-to-contribute/` instead of `https://gatsbyjs.org/contributing/how-to-contribute`.
- Follow the [Style Guide](/contributing/gatsby-style-guide/#word-choice) to make sure you're using the appropriate wording.
- Double check your grammar and capitalize correctly.
- Commit and push to your fork.
- Create a pull request from your branch.
- We recommend using a prefix of `docs`, e.g. `docs/your-change` or `docs-your-change`. ([PR example](https://github.com/gatsbyjs/gatsby/commit/9c21394add7906974dcfd22ad5dc1351a99d7ceb#diff-bf544fce773d8a5381f64c37d48d9f12))

### Blog post format

The following format can help you in creating your new blog content. At the top is "frontmatter": a fancy name for metadata in Markdown. The frontmatter for your post should include a title, date, singular author name (for now, we would welcome issues/PRs for this), and one or more tags. Your content will follow after the second set of dashes (`---`).

```md
---
title: "Your Great Blog Post"
date: YYYY-MM-DD
author: Jamie Doe
excerpt: "Here is a helpful excerpt or brief description of this blog post."
tags:
- awesome
- post
---
If you'd like to contribute a post to the Gatsby blog, please review the process and guidelines outlined below and submit your
idea for the post to our [Gatsby blog proposal form](https://airtable.com/shr3449954866i3iF)

### Blog proposal submission process

1. Complete and submit the [Gatsby blog proposal form](https://airtable.com/shr3449954866i3iF).
2. A Gatsby team member will review your proposal and let you know if the proposal has been accepted within the next week or so.
- **If the post is accepted:** A Gatsby team member will work with you on a timeline for submitting and reviewing a draft of your blog post and set a tentative publishing date.
- **If the post is not accepted:** We’ll let you know if there are any alternative offers we can make (e.g. offer to retweet if you publish the piece elsewhere, suggest submitting it as an addition to a Gatsby doc, etc.). We’ll also do our best to explain why your proposal was not accepted and encourage you to revise your proposal based on that feedback and resubmit. Please don’t be discouraged from submitting another post in the future!

If you have any questions about the process or your submission, please email [marketing@gatsbyjs.com](mailto:marketing@gatsbyjs.com).

### Content guidelines for submitting a blog post proposal

As a Gatsby community member, you have unique insight into the ins and outs of learning Gatsby, building with Gatsby, and contributing to Gatsby’s open source community. Contributing to the Gatsby blog is a great way to share your experiences and insights. Here are some guidelines for what kind of content is and isn’t a good fit for the Gatsby blog.

Things we’re looking for in Gatsby blog content:

- Information to help others overcome challenges you’ve faced while working with Gatsby
- Stories about how Gatsby helped you overcome different challenges on work and personal projects
- Gatsby case studies
- Showcasing a tool, fix, or other content you or someone else have contributed to Gatsby’s open source community
- Showcasing a tool, fix, or other content someone else has contributed to Gatsby’s open source community
- Clear and thoughtful explanations of technical details or complex concepts related to React, GraphQL, web and application development, open-source contribution, Gatsby core, and other Gatsby-adjacent subject matter
- Guidance and resources for learning React, GraphQL, HTML/CSS, web development, best practices, accessibility, SEO, Gatsby, different tool and CMS integrations, and other Gatsby-adjacent subject matter.
- Other topics that you think would be valuable to people learning about or working with Gatsby

Your next great blog post awaits!
Things we’d like to avoid on the Gatsby blog:

Include images by creating a folder for your post and including
Markdown and image files for easy linking.
- **Docs content.** Some content is better found in the Gatsby docs guides and tutorials, as it can be found in a section for related content and not buried under pages of other paginated blog posts.
- **Promotional content.** Please don’t submit content to the Gatsby blog solely for the purpose of promoting a product, yourself, or link-building.
- **Here’s what you can do instead:** If you have a product or project you want to share on the Gatsby blog, focus on practical information, and make sure there’s a clear relationship with Gatsby or Gatsby-adjacent topics. You could write a step by step guide to using your product with Gatsby. You could write a case study highlighting the direct impact Gatsby had on your awesome project and offer helpful tips for others to recreate your success.
- **Content that doesn’t seem to have a clear benefit for Gatsby users and/or the Gatsby community.** For example, if you’re writing about a use-case or integration that’s extremely niche or unique to specific conditions that are really uncommon outside of your organization, the Gatsby blog might not be the best place for your content. Likewise, if your blog post doesn’t seem to have any direct relationship with Gatsby (or an interesting indirect relationship with Gatsby), then it may be more appropriate for a personal blog or another community blog.

![awesome example](./image.jpg)
```
**Please note** that these are guidelines, not rules. If you think your blog post belongs on the Gatsby blog, we absolutely encourage you to submit it. While we reserve the right to decide what is and isn’t appropriate for the Gatsby blog, we also value and encourage your creativity and your contributions.

## Making changes to the website

Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/code-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ Check [Debugging the build process](/docs/debugging-the-build-process/) page to

## Feedback

At any point during the contributing process, the Gatsby Core team would love to help! We hold a weekly [Core Maintainer's meeting](/contributing/community#core-maintainers-meeting) where you can share your creation(s) and receive advice and feedback directly from the team!
At any point during the contributing process the Gatsby team would love to help! For help with a specific problem you can [open an issue on GitHub](/contributing/how-to-file-an-issue/). Or drop in to [our Discord server](https://gatsby.dev/discord) for general community discussion and support.
2 changes: 1 addition & 1 deletion docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Examples of unacceptable behavior by participants include:

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this code of conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned with this code of conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, divisive, threatening, offensive, or harmful.

## Scope

Expand Down
8 changes: 0 additions & 8 deletions docs/contributing/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,14 +45,6 @@ Sign up for the Gatsby newsletter to keep up with the latest from the Gatsby com
For the latest news about Gatsby,
[follow **@gatsbyjs** on Twitter](https://twitter.com/gatsbyjs).

### Community Maintainers Meeting

The Gatsby Core team (official Gatsby employees who are working on Gatsby open-source) holds a weekly meeting where we encourage community members to share their projects, struggles, and successes directly with the Gatsby Core team. Additionally the Core team shares pertinent info and plans that are applicable to the community!

This event is held on a recurring basis, every Wednesday at 8:30 AM Pacific Standard Time (PST).

[Add the recurring calendar invite here](https://gatsby.dev/core-maintainers)

## Where to get support

### Stack Overflow
Expand Down
7 changes: 7 additions & 0 deletions docs/contributing/docs-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,13 @@ After going through the [development setup instructions](/contributing/setting-u
- View the changes in your browser at `http://localhost:8000`.
- Commit your changes and [submit a pull request](/contributing/how-to-open-a-pull-request/)!

## Changing headers

It can be necessary to change a heading within the docs. It's important to note that headers automatically generate links with a corresponding URL that can be deep-linked from elsewhere on the site. When changing a header, be sure to point all corresponding links to the new URL. Here are some workflow tips:

- Determine the URL you're looking for. `Changing headers` is linked with a URL ending in `changing-headers`, `Docs renaming instructions` becomes `docs-renaming-instructions`, etc.
- Update all instances of the old URL to your new one. [Find and replace](https://code.visualstudio.com/docs/editor/codebasics#_search-across-files) in VS Code can help. Check that the context of the original link reference still makes sense with the new one.

## Docs renaming instructions

Sometimes it makes sense to move or rename a file as part of docs restructuring or for content clarification. While we recommend keeping URLs consistent as often as possible, here are some tips to minimize errors and keep the docs in a good state:
Expand Down
5 changes: 5 additions & 0 deletions docs/contributing/gatsby-docs-translation-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,16 +31,21 @@ The first step for starting a new translation is to check what exists. So far, t
- [Arabic](https://github.com/gatsbyjs/gatsby-ar)
- [German](https://github.com/gatsbyjs/gatsby-de)
- [Spanish](https://github.com/gatsbyjs/gatsby-es)
- [French](https://github.com/gatsbyjs/gatsby-fr)
- [Gujarati](https://github.com/gatsbyjs/gatsby-gu)
- [Hindi](https://github.com/gatsbyjs/gatsby-hi)
- [Indonesian](https://github.com/gatsbyjs/gatsby-id)
- [Italian](https://github.com/gatsbyjs/gatsby-it)
- [Korean](https://github.com/gatsbyjs/gatsby-ko)
- [Mongolian](https://github.com/gatsbyjs/gatsby-mn)
- [Dutch](https://github.com/gatsbyjs/gatsby-nl)
- [Polish](https://github.com/gatsbyjs/gatsby-pl)
- [Brazilian Portuguese](https://github.com/gatsbyjs/gatsby-pt-BR)
- [Russian](https://github.com/gatsbyjs/gatsby-ru)
- [Turkish](https://github.com/gatsbyjs/gatsby-tr)
- [Vietnamese](https://github.com/gatsbyjs/gatsby-vi)
- [Simplified Chinese](https://github.com/gatsbyjs/gatsby-zh-Hans)
- [Traditional Chinese](https://github.com/gatsbyjs/gatsby-zh-Hant)

> Note: Once a new translation repository is created, feel free to add it here in a PR!
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing/gatsby-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -385,7 +385,7 @@ For words that have multiple spellings, prefer the US English word over British

### Use apps that help you edit

Use the [Hemingway App](https://www.hemingwayapp.com/). There’s nothing magical
Use the [Hemingway App](https://hemingwayapp.com/). There’s nothing magical
about this tool, but it will automatically detect widely agreed-upon
style issues:

Expand Down
35 changes: 32 additions & 3 deletions docs/contributing/setting-up-your-local-dev-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,29 +19,58 @@ Yarn is a package manager for your code, similar to [NPM](https://www.npmjs.com/

## Gatsby repo install instructions

### Install Node and Yarn

- Ensure you have the latest **LTS** version of Node installed (>= 10.16.0). `node --version`
- [Install](https://yarnpkg.com/en/docs/install) the Yarn package manager.
- Ensure you have the latest version of Yarn installed (>= 1.0.2). `yarn --version`
- Fork the [official repository](https://github.com/gatsbyjs/gatsby).

### Fork, clone, and branch the repository

- [Fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the [official `gatsbyjs/gatsby` repository](https://github.com/gatsbyjs/gatsby).
- Clone your fork: `git clone --depth=1 https://github.com/<your-username>/gatsby.git`
- Set 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`

### Docs only changes

- See [docs setup instructions](/contributing/docs-contributions#docs-site-setup-instructions) for docs-only changes.
- 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](https://www.npmjs.com/package/gatsby-dev-cli) globally: `yarn global add gatsby-dev-cli`

### Gatsby functional changes

- Install [gatsby-cli](https://github.com/gatsbyjs/gatsby/blob/master/packages/gatsby-cli):
- Make sure you have the Gatsby CLI installed with `gatsby -v`,
- if not, install globally: `yarn global add gatsby-cli`
- Install [gatsby-dev-cli](https://github.com/gatsbyjs/gatsby/tree/master/packages/gatsby-dev-cli):
- Make sure you have the Gatsby Dev CLI installed with `gatsby-dev -h`
- if not, install globally: `yarn global add gatsby-dev-cli`
- Run `yarn install` in each of the sites you're testing.
- Make sure you have the Gatsby CLI installed with `gatsby -v`, if not run `yarn global add gatsby-cli`
- For each of your Gatsby test sites, run the `gatsby-dev` command inside the test site's directory 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](https://www.npmjs.com/package/gatsby-dev-cli) and check out the [gatsby-dev-cli demo video](https://www.youtube.com/watch?v=D0SwX1MSuas).

- Note: if you plan to modify packages that are exported from `gatsby` directly, you need to either add those manually to your test sites so that they are listed in `package.json` (e.g. `yarn add gatsby-link`), or specify them explicitly with `gatsby-dev --packages gatsby-link`).

### Add tests

- Add tests and code for your changes.
- Once you're done, make sure all tests still pass: `yarn test`.

- To run tests for a single package you can run: `yarn jest <package-name>`.
- To run a single test file you can run: `yarn jest <file-path>`.

### Commits and pull requests

- Commit and push to your fork.
- Create a pull request from your branch.

### Sync your fork

- GitHub Help Page [Syncing a fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork)
- GitHub Help Page [Merging an upstream repository into your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/merging-an-upstream-repository-into-your-fork)
73 changes: 0 additions & 73 deletions docs/contributing/submit-to-creator-showcase.md

This file was deleted.

0 comments on commit 5f730fe

Please sign in to comment.