Publishing: submit both backstage plugins to the Backstage Plugin Directory

coder / backstage-plugins

Official Coder plugins for the Backstage platform

40 stars 3 forks source link

Publishing: submit both backstage plugins to the Backstage Plugin Directory #35

Closed Kira-Pilot closed 7 months ago

Kira-Pilot commented 8 months ago

We should submit both of our Backstage plugins to the Backstage Plugin Directory so that users can more easily find our tools.

Steps for submitting are outlined here: https://backstage.io/docs/plugins/add-to-directory/

Changes left to make (after name change discussion)

[x] Make new PR in the Coder plugins repo to update the name of the frontend devcontainers plugin, and make sure that things are being published under the correct name
[x] Update the PR opened with Spotify, and update the link for the devcontainers plugin
[x] Update our README to reflect our status as an official Backstage plugin

Parkreiner commented 8 months ago

Going to put the badges stuff on hold until I get this done

Kira-Pilot commented 8 months ago

@bpmct @kylecarbs regarding naming: we have decided to keep the naming convention as-is; please see @Parkreiner's comment below for more detail.

Parkreiner commented 8 months ago

Took me a while to track this down, but there is a piece of documentation that describes what each suffix means internally

The two important ones being:

x: Contains the main frontend code of the plugin. x-react: Contains shared widgets, hooks and similar that both the plugin itself (x) and third-party frontend plugins can depend on.

Since we're not necessarily publishing a full-page plugin, but are instead giving people access to hooks and smaller components that they can bring into their own plugins, I feel like the current suffix makes sense. My read is that the plugin wouldn't have the suffix if we were publishing a single-purpose page component that isn't easy to extend, but for library-centric code, we do want it

This is making me wonder if we actually want to add the -react suffix to the Coder plugin, too. I'm going to try asking the Backstage people in the other PR, and see if we can't get a definitive answer

kylecarbs commented 7 months ago

Not a biggie to me. If it's accepted in the community, it's good with me.

Parkreiner commented 7 months ago

Wanted to give an update: it sounds like the core Backstage contributors think we're good with the current names.

We need two approvals to merge the changes in, though. We have one, but are waiting for another. I just asked whether there was anything else I need to do to get that last approval

Parkreiner commented 7 months ago

As of today, we are on the Backstage plugins page. Closing this out.

Parkreiner commented 7 months ago

Oh, actually, forgot one thing – updating the READMEs to indicate that we're official