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

docs: plugin authoring workflow overview pages #20847

Merged
merged 11 commits into from
Jan 30, 2020

Conversation

gillkyle
Copy link
Contributor

Description

This PR begins to implement docs recommendations from the plugin authoring workflow evaluation found in #20232 in the effort to improve Gatsby workflows from #13708.

The changes here make updates to some of the overview pages to link to more recent guides on plugins that have been added as well as adding additional context.

I added an example repository for loading local plugins using several different methods as well as a section on verifying that your plugin is loading since those were some things I had questions with when I started loading my own custom local plugins.

Related Issues

Related to #20232

I also started working on a flowchart/table of plugin vs theme vs starter features in reference to this card on the Learning Roadmap project: https://github.com/gatsbyjs/gatsby/projects/10#card-30093971 (but figured it could come in another PR)

@gillkyle gillkyle added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Jan 24, 2020
@gillkyle gillkyle requested a review from a team as a code owner January 24, 2020 18:33
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.

This is awesome as always @gillkyle! Made some suggestions below, let me know what you think.

docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
@gillkyle gillkyle requested a review from a team as a code owner January 27, 2020 16:28
@gillkyle gillkyle requested a review from laurieontech January 27, 2020 20:13
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.

A few minor changes, but in general I think this should be good.

docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
docs/docs/creating-a-local-plugin.md Outdated Show resolved Hide resolved
examples/using-multiple-local-plugins/README.md Outdated Show resolved Hide resolved
examples/using-multiple-local-plugins/README.md Outdated Show resolved Hide resolved
@gillkyle gillkyle requested a review from laurieontech January 29, 2020 21:35
@laurieontech
Copy link
Contributor

Looks good. Going to wait for tests but I think we can merge!

@laurieontech laurieontech merged commit adfb867 into master Jan 30, 2020
@delete-merged-branch delete-merged-branch bot deleted the docs/plugin-authoring-overview branch January 30, 2020 13:25
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.

2 participants