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

Docs plugin readme #20048

Merged
merged 4 commits into from
Dec 12, 2019
+8 −0
Merged

Docs plugin readme #20048

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
15d9888
Update plugin README template to account for themes and be more expli…
Dec 9, 2019
1492c99
Update plugin template to account for themes and more specific instal…
Dec 10, 2019
117cc40
Update docs/contributing/docs-templates.md
laurieontech Dec 12, 2019
9b6b820
Update docs/contributing/docs-templates.md
laurieontech Dec 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/contributing/docs-templates.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,6 +399,8 @@ them at the bottom in an "Other Resources" section. You can also mention here an

Include a summary of what this plugin accomplishes. Is there a demo site that shows how this plugin operates? If so, include a link to the deployed demo site and/or its source code here.

Themes are considered plugins in the Gatsby ecosystem and should follow this README as well. Note that themes include multiple READMEs. One inside the theme directory with configuration instructions, one inside the example project directory, and one in the root of the repository which will follow this guide.

### Dependencies (optional)

Are there any plugins that must be installed in order to make this plugin work? If so, please include a list of those plugins and links to their pages here.
Expand All @@ -411,6 +413,10 @@ If there are other tutorials, docs, and learning resources that are necessary or

Please include installation instructions here.

Gatsby documentation uses `npm` for installation. This is the recommended approach for plugins as well.

If the plugin is a theme that needs to use `yarn`, please point to [the documentation for switching package managers](/docs/gatsby-cli/#how-to-change-your-default-package-manager-for-your-next-project) in addition to the `yarn`-based instructions.

## Available options (if any)

## When do I use this plugin?
Expand All @@ -431,6 +437,8 @@ This section could also include before-and-after examples of data when the plugi

If this is a source plugin README, source plugins ought to allow people to query for data within their Gatsby site. Please include code examples to show how to query for data using your source plugin.

If this is a theme that requires data in a specific format in order to match an existing query, include those examples here.

## How to run tests

## How to develop locally
Expand Down