Gatsby: Polishing Plugin library

Created on 6 Mar 2018  ·  27Comments  ·  Source: gatsbyjs/gatsby

Description

The plugin library is in dark deploy, thanks to @gillkyle and many others!
This fixes Issue #3003.

Next steps based off of discussions w/ @fk, @KyleAMathews, and @calcsam.
@KyleAMathews do these things?

  • [x] Make sure deprecated packages are not appearing in plugin search
  • [x] Support searching for gatsby-library in addition to gatsby-plugin and gatsby-component
  • [x] Add "gatsby-plugin" keyword to package.json where missing
  • [x] show total count of plugins w/o any search
  • [x] script fetching all community plugins to find which ones aren't in the library and then PR adding keyword to them

@jlengstorf do this:

  • [x] Template for plugin READme's (#4284 thanks @jlengstorf) and can we make sure people know (possibly thru template and plugin instructions you wrote) that they need to use gatsby-plugin as a keyword, since Algolia search uses this?
  • [x] Add instructions to the page for plugin authors about how to get their plugin to show up — namely

    • [x] add "gatsby-plugin" as keyword

    • [x] wait 24 hours while Algolia reindexes

@fk do this:

Shannon do this:

  • [x] Figuring out _where_ the plugin library ought to reside and how to navigate there on gatsbyjs.org ("Packages on top nav desktop and bottom nav in mobile) --> edit plugin docs page to redirect to packages library and plugin authoring page

Notes on possible future enhancements to the library:

  • [x] Introduce filters (examples: filter by category, popularity, and what version of Gatsby the package works with)
  • [x] For each plugin, include a list of open source websites from the showcase (and how many) that are using the plugin

Most helpful comment

cc-ing repo owners if you want to fix things yourselves :-D @alampros @crgeary @julien1619 @didierfranc @marcobiedermann @dannywils @angeloocana @rongierlach @jlengstorf @kevzettler @Rulikkk @jcreamer898 @pixelstew @Jedidiah @angeloashmore @G100g @haysclark

All 27 comments

cc-ing repo owners if you want to fix things yourselves :-D @alampros @crgeary @julien1619 @didierfranc @marcobiedermann @dannywils @angeloocana @rongierlach @jlengstorf @kevzettler @Rulikkk @jcreamer898 @pixelstew @Jedidiah @angeloashmore @G100g @haysclark

Thanks for the heads up! Mine is updated.

Thanks! Mine gatsby-plugin-bugherd has been updated.

The deed is done -- gatsby-plugin-purify-css

gatsby-remark-emoji updated with keywords. Thanks.

gatsby-plugin-meta-redirect has been updated

I added a PR #4472 'Replace main navigation item "Community" with "Plugins"' over the weekend, preview here: https://deploy-preview-4472--gatsbyjs.netlify.com/

@KyleAMathews all listed plugins have now a PR to add the missing keyword ✅

@DirtyF merged and published ;)

@fk Will do!

Wow, thanks @DirtyF!
Thanks @jacobmischka!
🙏 🤗

Merged PR into gatsby-node-helpers. Thanks @DirtyF!

Merged in https://github.com/marcobiedermann/gatsby-plugin-svg-sprite/pull/2 for gatsby-plugin-svg-sprite by @DirtyF

@jlengstorf Opened #4622 before seeing this issue and that the task was already on your roadmap. feel free to adjust/suggest wording or close the issue if it's not what was in mind.

I think we should support versioned plugin, I'm planning publish some of my own plugins but realize that they are for Gatsby V2

for example packages for Sublime Text
image

@lowmess @jlengstorf I merged #4622 and checked it off at the top of this issue.

@nihgwu Can you explain more about this? Do you mean you want the plugin library to show what version of Gatsby the plugin is compatible with?

@shannonbux exactly

@fk and @jlengstorf and @KyleAMathews Are your checklists at the top of this issue updated? Happy to help where I can.

ALSO Kyle, I just updated the long checklist of plugins to reflect that PR's have been made and/or merged for the entire list of plugins! Wait to go everyone.

@shannonbux I need to write the README template still, and I haven't done anything about the Algolia notes.

I also think we discussed keeping plugins instead of packages even though it's technically more than plugins.

Maybe those should be tracked in separate issues (the README already is) and close this?

will do tomorrow! Thanks!

Fun being able to regularly see the count of plugins now — we're already up 8-10 or so since we launched the library

@nihgwu Just created issue #4671 to add filters to plugin library, which would include version compatibility! Thanks!

Ok closing this issue because I turned the remaining tasks into smaller issues in the UX project.

  • Maintain light purple selected state in plugin library #4670
  • Plugin library filters and sorting enhancements #4671
  • Plugin library list sites that use plugin #4672
  • Add Algolia notes to Plugin Authoring doc #4673
  • Create READme template for plugins #4284
Was this page helpful?
0 / 5 - 0 ratings

Related issues

ghost picture ghost  ·  3Comments

kalinchernev picture kalinchernev  ·  3Comments

timbrandin picture timbrandin  ·  3Comments

hobochild picture hobochild  ·  3Comments

jimfilippou picture jimfilippou  ·  3Comments