-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into doc-index.md
- Loading branch information
Showing
310 changed files
with
10,997 additions
and
4,397 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* text=auto eol=lf |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,8 @@ | ||
node_modules | ||
|
||
# We're using yarn, so no package-lock.json | ||
package-lock.json | ||
|
||
# Do not commit images | ||
images | ||
*.png |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
module.exports = { | ||
hooks: { | ||
"pre-commit": "pretty-quick --staged", | ||
}, | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
module.exports = { | ||
endOfLine: "lf", | ||
semi: false, | ||
trailingComma: "es5", | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 can do this by [opening an issue](https://github.com/gatsbyjs/gatsby/issues/new/choose) or contacting [@gatsbyjs on Twitter](https://twitter.com/gatsbyjs). | ||
|
||
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 [[email protected]](mailto:[email protected]). | ||
|
||
### 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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.