Add a new tab to the EntityPage for the Quarkus console

[cmoulliard]

Description

This PR:

• Add a new tab to the ./packages/app/src/components/catalog/EntityPage/index.tsx file in order to allow to display the Quarkus console
• Enhance the documentation page to better explain how to run locally the dynamic plugins with yarn start
• Add a Table of Contents to the dynamic-plugins.md file

Which issue(s) does this PR fix

• Fixes Add new tab EntityPage for the QuarkusConsole page #1147

PR acceptance criteria

Please make sure that the following steps are complete:

• GitHub Actions are completed and successful
• Unit Tests are updated and passing
• E2E Tests are updated and passing
• Documentation is updated if necessary (requirement for new features)
• Add a screenshot if the change is UX/UI related

How to test changes / Special notes to the reviewer

[github-actions]

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1154!

[davidfestal]

2 remarks here:

• Do you think you could create a dedicated PR for the Docs enhancement ?
• With dynamic plugins, we should not require changing the source code of the frontend application in order to wire a dynamic plugin. That seems like an anti-pattern. Users of the showcase that will want to bring their own plugins in a dedicated tab will not be able to change the showcase image . @tumido @gashcrumb Any idea about how to contribute a new tab ? I assume we should have something, right ?

[davidfestal]

@tumido @gashcrumb Any idea about how to contribute a new tab ? I assume we should have something, right ?

And if not the it seems to me it would be quite urgent to open an issue and plan it.

[cmoulliard]

• That seems like an anti-pattern.

I fully agree with you but my PR has been created based on discussions with @gashcrumb as currently this is the only way to add a tab

[cmoulliard]

• Do you think you could create a dedicated PR for the Docs enhancement ?

I can do that but then it will be needed to remove commits pushed on this PR ....

[cmoulliard]

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1154!

I did a test on our cluster using the image of the PR and that works too.

[davidfestal]

I can do that but then it will be needed to remove commits pushed on this PR ....

I assume this PR should be rebased yes, or possibly replaced b the new one.

BTW I don't really see the point in adding a TOC, since one is already constructed automatically by GH (as would be in other markdown viewers) based on the Markown structure:

[davidfestal]

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1154!

I did a test on our cluster using the image of the PR and that works too.

My main problem is that it seems to me that we should not need to create a new container image in order to add a tab specific to a dynamic plugin.

[cmoulliard]

BTW I don't really see the point in adding a TOC, since one is already constructed automatically by GH (as would be in other markdown viewers) based on the Markown structure:

I removed the TOC from this PR

[tumido]

So... The code is completely correct and valid.

Secondly, you should really think twice before adding new tabs. The fact that you can't just add a new tab by the dynamic plugins mechanism is 100% intentional. Our aim was to always reduce the amount of tabs we provide. We don't want to end up in a situation where we have a new tab per plugin.

Each tab should represent a purpose that is generic and common to every entity of the same kind and type in the catalog. That's why we don't have a distinct GitHub Actions tab and Tekton tab -> we have a single CI tab instead.

The presence of a new tab should be a PM/UX question, this is not something we should decide only on code quality/review basis.

[cmoulliard]

Each tab should represent a purpose that is generic and common to every entity of the same kind and type in the catalog. That's why we don't have a distinct GitHub Actions tab and Tekton tab -> we have a single CI tab instead.

The presence of a new tab should be a PM/UX question, this is not something we should decide only on code quality/review basis.

I agree with you and that will discussed soon between the Quarkus's Product Manager and RHDH team.

FYI: The Quarkus Console plugin could become (if approved by the different Runtime PMs) a runtime plugin supporting: Quarkus, Spring Boot, EAP, etc java runtimes

[davidfestal]

The fact that you can't just add a new tab by the dynamic plugins mechanism is 100% intentional

I think that even this assertion should be validated by PM / UX.
It might be that the availability of such an option (to place a dynamic plugin in a new tab) would still be required, even though not the default or the recommended way.

cc @christophe-f

[openshift-ci]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from davidfestal. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[sonarcloud]

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
1.1% Duplication on New Code

See analysis details on SonarCloud

[github-actions]

The image is available at: quay.io/janus-idp/backstage-showcase:pr-1154!

[christophe-f]

Like Tom mentioned, I agree that we should not ship too many tabs by default. 
With that said, a user should be able to create, remove, rename tabs as they wish and not be limited. We should definitely provide this feature.

We've been focusing a lot on the Component kind where most of the tabs are already present, but if someone would like to add more tab to the user, groups or custom Kind, currently they are not allowed.

[davidfestal]

Issue #1160 was opened for this purpose,to avoid fixing this with a plugin-specific fix.

[openshift-merge-robot]

PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

[invincibleJai]

Issue #1160 was opened for this purpose,to avoid fixing this with a plugin-specific fix.

@cmoulliard I see #1173 is merged and the associated issue is closed

so do we still need this PR or it can be closed?

cc @gashcrumb

[davidfestal]

so do we still need this PR or it can be closed?

No we don't need this PR anymore and it should be closed, since the corresponding required dynamic plugin support has been added in PR #1173

[gashcrumb]

Yep, this approach shouldn't be necessary anymore, so let's close this.