Skip to content

RHIDP-4801 - Plugins should be able to know on which Backstage they are running on. #756

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.

Sign up for GitHub

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

Closed
Gerry-Forde wants to merge 2 commits into from
Closed

RHIDP-4801 - Plugins should be able to know on which Backstage they are running on. #756

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8f60da4
RHIDP-4768 - Plugins should be able to know on which Backstage they a…
Gerry-Forde Nov 29, 2024
e4ef60d
Merge branch 'main' into RHIDP-4768-2
themr0c Dec 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,8 @@
// Viewing installed plugins
include::../modules/dynamic-plugins/proc-viewing-installed-plugins.adoc[leveloffset=+1]

// Identifying Backstage flavor for plugins

Check failure on line 24 in assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc

View workflow job for this annotation

GitHub Actions / Linting with Vale 

[vale] reported by reviewdog 🐶
[DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Backstage'.

Raw Output:
{"message": "[DeveloperHub.Attributes] Use the AsciiDoc attribute '{product}' rather than 'Backstage'.", "location": {"path": "assemblies/dynamic-plugins/assembly-installing-rhdh-plugins.adoc", "range": {"start": {"line": 24, "column": 16}}}, "severity": "ERROR"}
include::../modules/dynamic-plugins/proc-identifying-backstage-flavor-for-plugins.adoc[leveloffset=+1]

//basic plugin configuration
//include::../modules/dynamic-plugins/con-basic-config-dynamic-plugins.adoc[leveloffset=+1]
15 changes: 15 additions & 0 deletions modules/dynamic-plugins/proc-identifying-backstage-flavor-for-plugins.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
[id="proc-identifying-backstage-flavor-for-plugins_{context}"]
= Identifying Backstage flavor for plugins

You can use the `developerHub.flavor` field to identify whether plugins are running on {product-very-short}, RHTAP, or vanilla Backstage, as shown in the following example:
Copy link
Member

@PatAKnight PatAKnight Dec 3, 2024

Choose a reason for hiding this comment

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

So ideally this information is for customers who are creating plugins for their RHDH instance and need to know whether their plugin is running on RHDH, RHTAP, or vanilla Backstage. So, this would be something that is referenced only from within a plugin and would have no impact to RHDH. And should only be updated by a platform engineer if they are running anything other than RHDH.

To me this would make the most sense in docs that involve writing plugins for RHDH as just a highlight of how to determine what platform the plugin is currently installed to. But I don't believe that we have anything like that at the moment.

Copy link
Member Author

@Gerry-Forde Gerry-Forde Dec 3, 2024

Choose a reason for hiding this comment

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

@PatAKnight I see your point and I also struggled a bit to decide where this content should appear in our existing documentation.

We don't have any docs about writing plugins, so perhaps we could include it in the Configuring Dynamic Plugins guide which is intended for platform engineers to enable/configure plugins.

@hmanwani-rh @Preeticp Any thoughts? When we disassemble the Admin Guide, will we still have a Configure category, if so, what will be included in that category?

Copy link
Member Author

@Gerry-Forde Gerry-Forde Dec 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@PatAKnight Having discussed this with the Docs team (considering we don't have any creating plugins documentation), for this release, we think it best to place this content in the RNs.

c.c. @jmagak


.`app-config.yaml` fragment with the `developerhub.flavor` field

[source,yaml]
----
developerHub:
flavor: <flavor>
----

`flavor`::
Identify the flavor of Backstage that is running. Default value: `rhdh`
Loading