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.

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

[contributing] New doc on Gatsby's Docs Writing Process #21945

Merged
merged 7 commits into from
Mar 10, 2020

Conversation

marcysutton
Copy link
Contributor

Description

This PR introduces a new doc on the writing process for the Gatsby Docs. It's been on the to-do list for a while as we've engaged with contractors and team members, and pulls together information into one outcome-driven place (writing greenfield docs). In particular, this doc was written to help the process of writing learning materials for topics that aren't well known or understood as that's been a blocker for some writers in the past. It also takes the opportunity to educate contributors about our standards and conventions throughout the discovery and content writing process.

Feedback welcome!

Documentation

N/A

Related Issues

N/A

@marcysutton marcysutton added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Mar 4, 2020
@marcysutton marcysutton requested review from a team as code owners March 4, 2020 02:40
@marcysutton marcysutton added this to In progress in Documentation Roadmap via automation Mar 4, 2020
ShivamGoyal1899
ShivamGoyal1899 previously approved these changes Mar 6, 2020
Ekwuno
Ekwuno previously approved these changes Mar 6, 2020
Copy link
Contributor

@Ekwuno Ekwuno left a comment

Choose a reason for hiding this comment

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

Looks good to me! Thanks, Marcy 💜

Copy link
Contributor

@laurieontech laurieontech left a comment

Choose a reason for hiding this comment

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

Thanks for this Marcy! Lots of good information to help people contribute to the docs. Made some suggestions and asked some questions. Let me know what you think.

docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
docs/contributing/docs-writing-process.md Outdated Show resolved Hide resolved
Co-Authored-By: LB <laurie@gatsbyjs.com>
@marcysutton marcysutton dismissed stale reviews from Ekwuno and ShivamGoyal1899 via 5bc6799 March 10, 2020 02:59
@marcysutton
Copy link
Contributor Author

Ready for another review, @laurieontech! Thanks for your suggestions!

@laurieontech
Copy link
Contributor

Looks great Marcy!

@laurieontech laurieontech merged commit 41ddc9d into master Mar 10, 2020
Documentation Roadmap automation moved this from In progress to Done Mar 10, 2020
@delete-merged-branch delete-merged-branch bot deleted the docs-writing-process branch March 10, 2020 13:30
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
4 participants