HACDOCS-975: Adding JFrog Artifactory plugin content

[missmesss]

After some discussion it was decided that this content belongs to the RHDH docs (Plugins docs), not the RHTAP docs that I work on.

The PR contains 2 files:

• artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc is added to the Configuring dynamic plugins title
• artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-user.adoc is added to the Using dynamic plugins title

Version(s): 1.3
Issue: HACDOCS-975

[rhdh-bot]

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-714/ @ 01/13/25 19:49:05

[karthikjeeyar]

/lgtm

[missmesss]

@Gerry-Forde Thank you for looking at this PR and providing labels. We've discussed things with Karthik, this PR is waiting for a QE review now (but I can't tag Jan Richter here).

[missmesss]

@Gerry-Forde I have a couple of questions to you, when you have time, please.

Enabling VS Installing in the title
Which one should I keep? Most other plugin chapters are called “Installing and configuring”. At the same time the plugins are preinstalled with RHDH, and the procedures are about enabling them. There’s also a separate plugins installation guide. Might users get confused by that? Anyways, please, let me know if I should keep “Installing” in the title for historical and consistency reasons.

IDs
Do you use any IDs at the beginning of adocs? Some existing adocs begin with [[installation-and-configuration-tekton]], some with [id="installing-configuring-nexus-plugin"], some begin with a title.

-readmes
Some plugin repos have -readme docs alongside -admin and -user adocs. This PR has -admin and -user files only. Do I need to add a -readme file too? Readme files are included in titles/plugin-rhdh/title-plugin.adoc, but are they published anywhere?

Thank you in advance.

[Gerry-Forde]

@Gerry-Forde I have a couple of questions to you, when you have time, please.

Enabling VS Installing in the title Which one should I keep? Most other plugin chapters are called “Installing and configuring”. At the same time the plugins are preinstalled with RHDH, and the procedures are about enabling them. There’s also a separate plugins installation guide. Might users get confused by that? Anyways, please, let me know if I should keep “Installing” in the title for historical and consistency reasons.

IDs Do you use any IDs at the beginning of adocs? Some existing adocs begin with [[installation-and-configuration-tekton]], some with [id="installing-configuring-nexus-plugin"], some begin with a title.

-readmes Some plugin repos have -readme docs alongside -admin and -user adocs. This PR has -admin and -user files only. Do I need to add a -readme file too? Readme files are included in titles/plugin-rhdh/title-plugin.adoc, but are they published anywhere?

Thank you in advance.

@missmesss
Enabling VS Installing in the title For consistency we use the Installing and configuring title which may be a little confusing as most plugins just need to be enabled. However, in future RHDH releases, plugins may in fact need to be installed if they are available in a separate repository/marketplace. The plugins installation guide that you refer to is currently being revised for RHDH 1.4, and may focus more on the installation of third-party plugins rather than pre-installed plugins.

IDs We should have IDs at the beginning of each document. Some of the content you see was originally sourced upstream and may use the anchor ([[]]) syntax for IDs. My preference is to use the the longhand (id=) syntax.

-readmes Again these are a legacy of sourcing upstream content, we do not use them in the RHDH docs and are only present for reference purposes (in fact, to avoid confusion,we should remove them once we have published content).

[missmesss]

@jrichter1 and @Gerry-Forde Thank you so much for the feedback, I've added everything.
Sorry about the delay, the new RHTAP docs grabbed all of my attention. Released yesterday, yay.

[hmanwani-rh]

@missmesss Please rebase this PR

[missmesss]

@karthikjeeyar @jrichter1 I hope we all enjoyed the holidays and the break and can now resolve the 1 remaining question remaining and close this PR :)

As per Jan's comment above, the source files don't need any changes if we're talking about the production RHDH instance.
So do app-config.yaml and packages/app/src/components/catalog/EntityPage.tsx need changes for the Artifactory plugin to work with DH? The plugin is a tech.preview, does it matter in this case?

Thanks!

[missmesss]

@karthikjeeyar @jrichter1 The config step about modifying EntityPage.tsx has been removed now. Please, confirm this PR can be merged. Thank you.

The Configuration part is now 2 steps:

1. Set the proxy in app-config.yaml
2. Add annotation to catalog-info.yaml
   I hope it's correct now.

[karthikjeeyar]

FYI, Jfrog and all other plugins are now moved to backstage-community repo and janus-idp version is
deprecated in release 1.4. I see you have this PR for rhdh 1.3 so what you have here is correct but for rhdh 1.4 onwards this path changes to :

      - package: ./dynamic-plugins/dist/backstage-community-plugin-jfrog-artifactory

[missmesss]

@Gerry-Forde Will this PR become part of the RHDH 1.4 docs? I'll then change the path to include backstage-community as Karthik suggests.
Also, is cherry-picking to 1.3 docs required? Does your team maintain docs released earlier?

[karthikjeeyar]

/lgtm