Skip to content

Conversation

@Gerry-Forde
Copy link
Member

@Gerry-Forde Gerry-Forde commented Apr 21, 2025

IMPORTANT: Do Not Merge - To be merged by Docs Team Only

Version(s):
1.6

Issue:
RHIDP-6584

Preview:
Installing a plugin by using Extensions

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Apr 21, 2025

@Gerry-Forde Gerry-Forde marked this pull request as draft April 22, 2025 12:01
Copy link
Member

@zdrapela zdrapela left a comment

Choose a reason for hiding this comment

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

The docs show the community version, but the RC 1.6-88 shows the productized version
2025-05-06 14 51 10 backstage-developer-hub-zdrapela-op apps testday16 eastus aroapp io c2a30a82a08e
2025-05-06 14 50 58 backstage-developer-hub-zdrapela-op apps testday16 eastus aroapp io 66546e46ee77

@Gerry-Forde
Copy link
Member Author

Gerry-Forde commented May 7, 2025

Test Day Feedback:

  • Docs show the screenshot with Pipelines With Tekton by Backstage Community
  • The procedure for installing plugins should say that the user should be in the Extensions page, and use the search there, not RHDH's header search bar (or the bigger search bar on the landing page). Even if they're on the right page, there are two search bars, and only one will give the results expected by the procedure, it should specify which to use.
  • The screenshot here https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-1084/plugins-rhdh-install/images/rhdh-plugins-reference/rhdh-extensions-tekton-card.png doesn't include the blue highlight on the Extensions nav item in the sidebar, which makes it harder to understand from the screenshot where they are in the UI, or how they got there, if the procedure doesn't specify a starting point.
  • The Tekton displayed is also the Community version, and what we see in test day is the Red Hat provided option, which has a different icon. I don't see the community version listed.
  • Adding "catalog" or some other qualifer after Extensions, at least when introducing it, would help clear up potential ambiguity.
  • Navigational elements in the UI to be visible in the screenshots and match what users will see, wherever possible.
  • Installation instructions should specify dynamic-plugins.yaml as the file to be modified
  • There should be a caveat that the RHDH project may need to be rolled out manually if installed via HELM in order for the plugin to become enabled.

@Gerry-Forde
Copy link
Member Author

A few small comments, @Gerry-Forde.

@jmagak Thank you, I've incorporated your suggestions. Could you provide an approval please?

@Gerry-Forde Gerry-Forde marked this pull request as ready for review May 12, 2025 13:22
@hmanwani-rh hmanwani-rh merged commit 3d878cb into redhat-developer:release-1.6 May 13, 2025
5 checks passed
@hmanwani-rh
Copy link
Member

/cherry-pick release-1.6

@openshift-cherrypick-robot
Copy link
Contributor

@hmanwani-rh: I cannot cherry-pick the present PR on top of its base branch (release-1.6).

In response to this:

/cherry-pick release-1.6

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-sigs/prow repository.

@Gerry-Forde
Copy link
Member Author

/cherry-pick main

@openshift-cherrypick-robot
Copy link
Contributor

@Gerry-Forde: new pull request created: #1161

In response to this:

/cherry-pick main

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-sigs/prow repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants