RHIDP-4801 - Plugins should be able to know on which Backstage they are running on. #756
Conversation
Gerry-Forde
added
Peer review needed 📖
do-no-merge/review-in-progress 👀
QE review needed 🔧
Technical review needed 🔩
|
Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-756/ @ 12/03/24 14:38:17 |
| [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: |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
@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
Gerry-Forde
changed the title
|
Closing as this content has been moved to the RNs for RHDH 1.4 |
4 participants
RHIDP-4768 - Plugins should be able to know on which Backstage they are running on.
IMPORTANT: Do Not Merge - To be merged by Docs Team Only
Version(s):
1.4
Add the relevant labels to the Pull Request.
Issue:
RHIDP-4801