[docs] Plugin Authoring doc: publishing info #7733
Conversation
I've added a couple of paragraphs under a new H2 for _Publishing a plugin to the library_ to help with #4673 . Instead of just adding a tiny note on how much time Algolia would take to add the page to the library, based on my previous experience, I thought it was best to create a new section on publishing as it could be a bit confusing for beginners (in the very least, it was for me). The wording is still probably a bit off, feel free to suggest changes 😄 **PS:** In the first section of this page we say we'll review "what a plugin is _not_", but I don't this in any explicit way here... what was your line of thought in including this?
docs/docs/plugin-authoring.md
Outdated
|
|
||
| ## Publishing a plugin to the library | ||
|
|
||
| In order to add your plugin to the [Plugin Library], you need to simply publish a package to NPM (learn how [here](https://docs.npmjs.com/getting-started/publishing-npm-packages)) with the [required files](#what-files-does-gatsby-look-for-in-a-plugin) and **include a `keywords` field** to `package.json` containing `gatsby` and `gatsby-plugin`. |
There was a problem hiding this comment.
We try to avoid words like "simply", because to a first-timer, publishing a package to npm may not feel simple. Could you remove "simply" here?
Also, npm branding dictates that their name is all lowercase.
|
Thanks so much for this, @hcavalieri! RE: this question:
To be honest, I'm not sure what the original plan was for this. If it's unclear, we can tackle that in a follow-up PR to prevent this one from ballooning in scope. |
|
@jlengstorf great point on the usage of "simply"! I myself felt quite intimidated about publishing a package, until I did it hahah GitHub tells me you've made some changes but I couldn't see them, so I went ahead and commited a new version without this word and using "npm" ;) On my question: let me know what you find out, I'd be glad to help doing this other PR 😄 |
There was a problem hiding this comment.
Thanks @hcavalieri 👍
That what a plugin is not section was recently moved to the plugin overview page. As we're talking about it anyway I went ahead and removed the redundant header.
|
Holy buckets, @hcavalieri — we just merged your PR to Gatsby! 💪💜 Gatsby is built by awesome people like you. Let us say “thanks” in two ways:
If there’s anything we can do to help, please don’t hesitate to reach out to us: tweet at @gatsbyjs and we’ll come a-runnin’. Thanks again! |
I've added a couple of paragraphs under a new H2 for Publishing a plugin to the library to help with #4673 .
Instead of just adding a tiny note on how much time Algolia would take to add the page to the library, based on my previous experience, I thought it was best to create a new section on publishing as it could be a bit confusing for beginners (in the very least, it was for me). The wording is still probably a bit off, feel free to suggest changes 😄
PS: In the first section of this page we say we'll review "what a plugin is not", but I don't this in any explicit way here... what was your line of thought in including this?
closes #4673