[v2] docs "Plugins" overview #7229
Conversation
|
Deploy preview for using-postcss-sass failed. Built with commit c853ca9 https://app.netlify.com/sites/using-postcss-sass/deploys/5b6dd09a73f2cf7bcdbabb9b |
|
Deploy preview for using-drupal ready! Built with commit c853ca9 |
|
Deploy preview for gatsbygram ready! Built with commit c853ca9 |
|
Deploy preview for gatsbyjs failed. Built with commit c853ca9 https://app.netlify.com/sites/gatsbyjs/deploys/5b6dd09973f2cf7bcdbabb90 |
shannonbux
left a comment
shannonbux
left a comment
There was a problem hiding this comment.
This is looking great, @amberleyromo! Just left a few comments, and looping Mike and Michal in to make sure we're updating the plugin authoring doc thoroughly :)
|
|
||
| ## Build and publish a plugin | ||
|
|
||
| For a walkthrough of how to build and publish your own plugin, see the [source plugin tutorial](/docs/source-plugin-tutorial/). |
There was a problem hiding this comment.
would it make sense to link to a stub article(s) for other plugin tutorials (transformer plugin tutorial, for example)?
There was a problem hiding this comment.
Yes! Great idea. Let me know if I'm missing any:
- source plugin tutorial
- transformer plugin tutorial (aka tutorial part six)
- source plugin example usage (aka tutorial part five)
|
|
||
| Gatsby has a large and growing set of plugins. To search/browse official and | ||
| community plugins and their documentation, visit the [Plugin Library](/plugins/). | ||
| - add external data or content (e.g. your CMS, static files, a REST API) to your Gatsby GraphQL data |
There was a problem hiding this comment.
Nice, this does seem to belong here rather than in /plugin-authoring/. These docs have needed to be re-organized for a long time! What a relief!
| @@ -1,15 +1,14 @@ | |||
| --- | |||
| title: Plugin Authoring | |||
| title: Plugin authoring | |||
There was a problem hiding this comment.
@m-allanson and @pieh do you remember if there's anything else that needs to be edited about this page? (i.e. common obstacles contributors are running into when they submit plugins?). I remember Mike, you were mentioning recently that you created an issue to help plugin authors signify what version of Gatsby their plugin is compatible with. Or was it the other way around, just helping people vet which plugins work for v2? Either way, wondering if there's something that needs to be edited here in this doc)
There was a problem hiding this comment.
Oh good idea - here the issue: #7143.
I think we could merge this PR and then make another pass on the plugin docs to mention the Gatsby peerDependency?
There was a problem hiding this comment.
I'm not sure where it would fit in - but maybe this could mention something about learning from the source code of existing plugins?
Most plugins are open source and the code is often quite readable - if you're looking to write your own plugin it can be useful to review the source of similar plugins.
There was a problem hiding this comment.
Thinking further on this - maybe encourage people to write in a style that others can learn from?
That could be going too far off-track for this doc though. Sometimes people just need to get their stuff done and move on to the next job, so being told how to write your code here could be counter-productive.
m-allanson
left a comment
m-allanson
left a comment
There was a problem hiding this comment.
Great stuff, thanks @amberleyromo 👍 I left a couple of comments but I think this is good to merge, any followups (if needed) can go in a new PR.
| @@ -1,15 +1,14 @@ | |||
| --- | |||
| title: Plugin Authoring | |||
| title: Plugin authoring | |||
There was a problem hiding this comment.
Oh good idea - here the issue: #7143.
I think we could merge this PR and then make another pass on the plugin docs to mention the Gatsby peerDependency?
| @@ -1,15 +1,14 @@ | |||
| --- | |||
| title: Plugin Authoring | |||
| title: Plugin authoring | |||
There was a problem hiding this comment.
I'm not sure where it would fit in - but maybe this could mention something about learning from the source code of existing plugins?
Most plugins are open source and the code is often quite readable - if you're looking to write your own plugin it can be useful to review the source of similar plugins.
| @@ -1,15 +1,14 @@ | |||
| --- | |||
| title: Plugin Authoring | |||
| title: Plugin authoring | |||
There was a problem hiding this comment.
Thinking further on this - maybe encourage people to write in a style that others can learn from?
That could be going too far off-track for this doc though. Sometimes people just need to get their stuff done and move on to the next job, so being told how to write your code here could be counter-productive.
* master: (597 commits) Add a site(https://mojaave.com) to showcase list (gatsbyjs#7275) feat: create a doc for open source pair programming sessions (gatsbyjs#7266) [docs] Add video lesson to the StaticQuery docs (gatsbyjs#7249) [v2] docs - update page query docs (gatsbyjs#7285) [v2] docs "Styling" overview (gatsbyjs#7288) Remove delay (gatsbyjs#7273) add site (gatsbyjs#7291) Adding new site to the showcase. (gatsbyjs#7281) chore(release): Publish initial webpack externals support (gatsbyjs#7245) add missing package dependencies (gatsbyjs#7259) add: custom configuration overview (gatsbyjs#7231): tutorial part four updates (gatsbyjs#7240) [www] Fix showcase search, checkbox styles (gatsbyjs#7014) (gatsbyjs#6584): Restructure plugin overview and plugin authoring pages (gatsbyjs#7229) Use Hubspot form for email subscription (gatsbyjs#7233) Adding bootstrap CV starter (gatsbyjs#7207) Stub Articles and new names (gatsbyjs#7200) Improve readability of verbose logging code in wordpress source plugin (gatsbyjs#7146) Update hash link to scroll to right section of page (gatsbyjs#7161) ...
5 participants
Closes #6584.
Reorg (a lot of good overview language was already in the plugin authoring page), adding more structure, some language tweaks.