Skip to content

Commit

Permalink
Merge branch 'master' into doc-index.md
Browse files Browse the repository at this point in the history
  • Loading branch information
asantarissy authored Feb 23, 2020
2 parents 1a9ac19 + ff69d99 commit 3b2aa4c
Show file tree
Hide file tree
Showing 310 changed files with 10,997 additions and 4,397 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text=auto eol=lf
6 changes: 6 additions & 0 deletions .gitignore
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
5 changes: 5 additions & 0 deletions .huskyrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
hooks: {
"pre-commit": "pretty-quick --staged",
},
}
5 changes: 5 additions & 0 deletions .prettierrc.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = {
endOfLine: "lf",
semi: false,
trailingComma: "es5",
}
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 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

Expand Down
34 changes: 17 additions & 17 deletions docs/contributing/code-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ With all of the possible Gatsby integrations, it might help to spin up a Docker

To install WordPress to use with Gatsby, this `docker-compose.yml` file will come in handy:

```
version: '2'
```yaml:title=docker-compose.yml
version: "2"
services:
db:
Expand Down Expand Up @@ -91,22 +91,22 @@ services:
WORDPRESS_DB_HOST: db:3306
WORDPRESS_DB_PASSWORD: wordpress
volumes:
- ./wp-content:/var/www/html/wp-content
- ./wp-app:/var/www/html
- ./wp-content:/var/www/html/wp-content
- ./wp-app:/var/www/html
phpmyadmin:
image: phpmyadmin/phpmyadmin
container_name: sessions_phpmyadmin
environment:
- PMA_ARBITRARY=1
- PMA_HOST=sessions_db
- PMA_USER=wordpress
- PMA_PASSWORD=wordpress
restart: always
ports:
- 8080:80
volumes:
- /sessions
image: phpmyadmin/phpmyadmin
container_name: sessions_phpmyadmin
environment:
- PMA_ARBITRARY=1
- PMA_HOST=sessions_db
- PMA_USER=wordpress
- PMA_PASSWORD=wordpress
restart: always
ports:
- 8080:80
volumes:
- /sessions
```

Use the above file contents when following the Docker WordPress install instructions: https://docs.docker.com/compose/wordpress/
Expand All @@ -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/community-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ We welcome all contributions from you in the community, and would be thrilled to
- [Submit to Starter Library](/contributing/submit-to-starter-library/)
- [Submit to Plugin Library](/contributing/submit-to-plugin-library/)

Peruse through the rest of our contributor docs and reach out to us on [Twitter](https://twitter.com/gatsbyjs), [Discord](https://gatsby.dev/discord), or in a [GitHub issue](/contributing/how-to-file-an-issue/) if you have any questions about contributing!
Peruse the rest of our contributor docs and reach out to us on [Twitter](https://twitter.com/gatsbyjs), [Discord](https://gatsby.dev/discord), or in a [GitHub issue](/contributing/how-to-file-an-issue/) if you have any questions about contributing!
12 changes: 3 additions & 9 deletions docs/contributing/community.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Community
---

As of September 2019, the Gatsby community is comprised of over 2,400 contributors and tens of thousands of developers building both personal and commercial websites on Gatsby.
As of December 2019, the Gatsby community is comprised of over 2,800 contributors and tens of thousands of developers building both personal and commercial websites on Gatsby.

Open source doesn’t always have the best reputation for being friendly and welcoming, and that makes us sad. **Everyone belongs in open source, and Gatsby is dedicated to making you feel welcome.**

Expand All @@ -27,8 +27,10 @@ The Gatsby community welcomes contributions. Please refer to the guides below on

- [How to Contribute](/contributing/how-to-contribute/)
- [How to File an Issue](/contributing/how-to-file-an-issue/)
- [How to Open a Pull Request](/contributing/how-to-open-a-pull-request/)
- [Make feature requests with an RFC](/blog/2018-04-06-introducing-gatsby-rfc-process/)
- [Gatsby Style Guide](/contributing/gatsby-style-guide/)
- [Gatsby Translations](/contributing/gatsby-docs-translation-guide/)

## Gatsby news

Expand All @@ -43,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
Loading

0 comments on commit 3b2aa4c

Please sign in to comment.