Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: update /contributing docs #30607

Merged
merged 27 commits into from
Apr 9, 2021
Merged

docs: update /contributing docs #30607

merged 27 commits into from
Apr 9, 2021

Conversation

meganesu
Copy link
Contributor

@meganesu meganesu commented Apr 1, 2021 •
edited
Loading

Description

This PR updates the docs under the /contributing part of the Gatsby site, to align with recent changes from the docs reorg project.

More specifically, this PR:

  • Reorganizes files into subfolders, to make them easier to find.
  • Updates the docs templates to match the new doc types: How-To Guides, Reference Guides, Conceptual Guides, and the Tutorial.

TODO:

  • Add redirects for files that were moved or deleted.
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Apr 1, 2021
@meganesu meganesu added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Apr 1, 2021
@meganesu meganesu marked this pull request as ready for review April 7, 2021 04:52
LekoArts
LekoArts suggested changes Apr 7, 2021
View reviewed changes
Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some smaller comments but overall great improvements!
docs/contributing/blog-contributions.md Show resolved Hide resolved
docs/contributing/docs-contributions/docs-structure.md Outdated Show resolved Hide resolved
docs/contributing/docs-contributions/docs-structure.md Outdated Show resolved Hide resolved
docs/contributing/docs-contributions/how-to-write-a-conceptual-guide.md Show resolved Hide resolved
docs/contributing/docs-contributions/how-to-write-a-conceptual-guide.md Outdated Show resolved Hide resolved
docs/contributing/docs-contributions/how-to-write-a-how-to-guide.md Show resolved Hide resolved
docs/contributing/docs-contributions/how-to-write-a-plugin-readme.md Outdated Show resolved Hide resolved
docs/contributing/docs-contributions/how-to-write-a-reference-guide.md Show resolved Hide resolved
docs/contributing/stub-list.md Show resolved Hide resolved
docs/docs/how-to/plugins-and-themes/using-a-plugin-in-your-site.md Show resolved Hide resolved
meganesu and others added 2 commits April 7, 2021 16:18
@LekoArts
Copy link
Contributor

LekoArts commented Apr 8, 2021

Now that the stubs are deleted, I think some issues here are/were the respective stub issues: https://github.com/gatsbyjs/gatsby/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3A+documentation%22
@meganesu meganesu requested a review from LekoArts April 8, 2021 23:21
@meganesu
Copy link
Contributor Author

meganesu commented Apr 8, 2021

Now that the stubs are deleted, I think some issues here are/were the respective stub issues: https://github.com/gatsbyjs/gatsby/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22type%3A+documentation%22

@LekoArts Good catch. I closed the issues.

I think I've addressed all the comments. Thanks for the review! Could you approve this? I'll handle coordinating merging this and the mansion PR.
@meganesu meganesu merged commit 5c3faff into master Apr 9, 2021
@meganesu meganesu deleted the docs/docs-contributions branch April 9, 2021 23:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
2 participants
@meganesu @LekoArts