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

chore: add docs on gatsby-provision #36263

Merged

Conversation

aghreed
Copy link
Contributor

@aghreed aghreed commented Jul 29, 2022

Description

Adds a page to our docs for the gatsby-provision convention, existing gatsby-provision-* packages, as well as guidelines for creating authoring your own gatsby-provision-* package.

Documentation

Still need to determine the best place for this doc to live. Very open to suggestions. Feels somewhere between gatsby-source plugins and Gatsby config files to me.

EDIT: decided the most fitting place was in Reference > Config Files.

Related Issues

sc-52287

@aghreed aghreed added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jul 29, 2022
@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jul 29, 2022
@aghreed aghreed removed the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jul 29, 2022
@@ -0,0 +1,44 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

This doc shouldn't be added to the /docs/docs directory but be grouped into one of the child folders. What type of guide is this? How-To, Reference?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yep! This was a temporary home for it while we discussed where the best place for it to live would be.

I see this more as a reference than a how-to, and most akin to a configuration file, so I've opted to place it under /reference/config-files/.

@aghreed aghreed dismissed a stale review via 34853bc August 1, 2022 13:00
@aghreed aghreed marked this pull request as ready for review August 1, 2022 13:01
@aghreed aghreed merged commit 70e85be into master Aug 1, 2022
@aghreed aghreed deleted the aghreed/sc-52287/ga-documentation-for-cms-content-provisioning branch August 1, 2022 16:46
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants