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: new source plugin tutorial #23363

Merged
merged 18 commits into from
May 6, 2020
Merged

Conversation

gillkyle
Copy link
Contributor

Description

This is the final step of the long worked on plugin authoring workflow.

This (rather big) tutorial was an effort to improve the materials supporting more advanced use cases for plugins. It's an extension of the new source plugin guide that uses a more sophisticated example for reference. That example is rebuilt in the tutorial to teach:

  • sourcing nodes
  • remote image optimization
  • understanding of inference
  • foreign key relationships and schema customization
  • proactive data updates with GraphQL subscriptions

Retiring the Pixabay tutorial:

The Pixabay tutorial provides some good context, but doesn't explain some of those key features. I propose removing it in favor of this new tutorial, many of the sections were taken from the old guide and modified. I think this new tutorial will cover more commonly implemented features and set users up for integration with Gatsby Cloud (which was one of its goals).

View partial screenshot

localhost_8000_tutorial_source-plugin-tutorial_ (1)

Related Issues

Fixes #16095

@gillkyle gillkyle added the type: documentation An issue or pull request for improving or updating Gatsby's documentation label Apr 21, 2020
@gillkyle gillkyle requested review from a team as code owners April 21, 2020 23:04
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.

Wanted to read through the whole thing but dang, this is long. Well done! So just a couple of comments for the first parts - if you specifically target those later in the text feel free to ignore :)

docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
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.

What a lift Kyle! Great work. Left some recommendations.

My general opinion is that this is such a big improvement we should get it in soon and deal with any small tweaks down the road. That being said, I'd like to take a detailed look at the headings to make sure people can jump to sections if they want examples given the length of the tutorial. Would also be good to triple check we're not mixing any other pixabay references.

docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
LB and others added 7 commits April 24, 2020 10:56
Co-Authored-By: Kyle Gill <kylerobertgill@gmail.com>
Co-Authored-By: LB <laurie@gatsbyjs.com>
Co-Authored-By: Lennart <lekoarts@gmail.com>
Co-Authored-By: LB <laurie@gatsbyjs.com>
Co-Authored-By: LB <laurie@gatsbyjs.com>
@gillkyle gillkyle added the status: awaiting reviewer response A pull request that is currently awaiting a reviewer's response label May 4, 2020
Copy link

@AishaBlake AishaBlake left a comment

Choose a reason for hiding this comment

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

As always, this was both thorough and wonderful. I have a few non-punctuation comments but it's very nearly good to go. Thanks for all your time and work on this, Kyle!

docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
docs/tutorial/source-plugin-tutorial.md Outdated Show resolved Hide resolved
@AishaBlake AishaBlake removed the status: awaiting reviewer response A pull request that is currently awaiting a reviewer's response label May 5, 2020
Co-authored-by: Aisha Blake <aisha@gatsbyjs.com>
@gillkyle gillkyle requested a review from AishaBlake May 6, 2020 16:17
Copy link

@AishaBlake AishaBlake 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 looking great! Thanks for picking up those changes and for doing all this work in the first place, Kyle!

@AishaBlake AishaBlake dismissed laurieontech’s stale review May 6, 2020 18:19

All comments addressed

@AishaBlake AishaBlake merged commit 2630758 into master May 6, 2020
@delete-merged-branch delete-merged-branch bot deleted the docs/source-plugin-tutorial branch May 6, 2020 18:21
@muescha
Copy link
Contributor

muescha commented May 27, 2020

PS: i deleted my comments and will open a new issue when i completed the tutorial myself

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.

[docs][tutorial] building a source plugin tutorial
5 participants