HACDOCS-975: Adding JFrog Artifactory plugin content #714

missmesss · 2024-11-15T21:50:03Z

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 · 2024-11-15T21:52:12Z

Updated preview: https://redhat-developer.github.io/red-hat-developers-documentation-rhdh/pr-714/ @ 01/06/25 20:27:25

karthikjeeyar

/lgtm

openshift-ci · 2024-11-19T06:07:35Z

New changes are detected. LGTM label has been removed.

missmesss · 2024-11-21T21:34:34Z

@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 · 2024-11-21T21:38:38Z

@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.

artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc

jrichter1 · 2024-11-25T11:06:37Z

artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc

+. Enable the *Image Registry* tab on the entity view page in `packages/app/src/components/catalog/EntityPage.tsx`:
+
+[source,yaml]
+----
+/* highlight-add-start */
+import {
+  isJfrogArtifactoryAvailable,
+  JfrogArtifactoryPage,
+} from '@janus-idp/backstage-plugin-jfrog-artifactory';
+/* highlight-add-end */
+
+const serviceEntityPage = (
+  <EntityLayout>
+    // ...
+    {/* highlight-add-start */}
+    <EntityLayout.Route
+      if={isJfrogArtifactoryAvailable}
+      path="/image-registry"
+      title="Image Registry"
+    >
+      <JfrogArtifactoryPage />
+    </EntityLayout.Route>
+    {/* highlight-add-end */}
+  </EntityLayout>
+);
+----


Are we talking about a production RHDH instance here? There should be no need for editing the source files.

In any case the source here is not a yaml file, it is tsx.

@jrichter1 I think it's about a production instance, yes. And the plugin is tech preview, does it change anything?

Maybe @karthikjeeyar could share some details? Do app-config.yaml and packages/app/src/components/catalog/EntityPage.tsx need changes for the Artifactory plugin to work with DH?
Thanks!

Gerry-Forde · 2024-11-28T11:45:01Z

@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 · 2024-12-12T23:30:28Z

@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 · 2025-01-06T08:21:31Z

@missmesss Please rebase this PR

missmesss · 2025-01-06T20:34:24Z

@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!

Gerry-Forde · 2025-01-07T19:37:27Z

artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc

+      secure: true
+----
+
+. Enable the *Image Registry* tab on the entity view page in `packages/app/src/components/catalog/EntityPage.tsx`:


@missmesss As referred to by @jrichter1, I don't believe this section is required in the RHDH documentation and should be removed.

missmesss temporarily deployed to external November 15, 2024 21:50 — with GitHub Actions Inactive

karthikjeeyar reviewed Nov 19, 2024

View reviewed changes

openshift-ci bot assigned karthikjeeyar Nov 19, 2024

openshift-ci bot added the lgtm label Nov 19, 2024

openshift-ci bot removed the lgtm label Nov 19, 2024

missmesss temporarily deployed to external November 19, 2024 06:07 — with GitHub Actions Inactive

Gerry-Forde added Peer review needed 📖 SME review needed 🔩 QE review needed 🔧 do-no-merge/review-in-progress 👀 and removed SME review needed 🔩 labels Nov 21, 2024

missmesss temporarily deployed to external November 21, 2024 21:11 — with GitHub Actions Inactive

jrichter1 reviewed Nov 25, 2024

View reviewed changes

artifacts/rhdh-plugins-reference/jfrog-artifactory/jfrog-artifactory-plugin-admin.adoc Outdated Show resolved Hide resolved

jrichter1 reviewed Nov 25, 2024

View reviewed changes

themr0c requested a review from Gerry-Forde November 28, 2024 08:31

themr0c added the SME review done ⛅ label Nov 28, 2024

themr0c temporarily deployed to external December 3, 2024 13:27 — with GitHub Actions Inactive

missmesss temporarily deployed to external December 12, 2024 21:54 — with GitHub Actions Inactive

missmesss temporarily deployed to external December 12, 2024 22:01 — with GitHub Actions Inactive

missmesss added 4 commits January 6, 2025 12:25

adding artifactory plugin content

aa0af80

minor update

9af1e40

bit more info

e860d21

reviews feedback

5b6d099

missmesss force-pushed the HACDOCS-975-jfrog-artifactory-plugin branch from 88dd635 to 5b6d099 Compare January 6, 2025 20:25

missmesss temporarily deployed to external January 6, 2025 20:25 — with GitHub Actions Inactive

Gerry-Forde reviewed Jan 7, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

HACDOCS-975: Adding JFrog Artifactory plugin content #714

HACDOCS-975: Adding JFrog Artifactory plugin content #714

missmesss commented Nov 15, 2024 •

edited

Loading

rhdh-bot commented Nov 15, 2024 •

edited

Loading

karthikjeeyar left a comment

openshift-ci bot commented Nov 19, 2024

missmesss commented Nov 21, 2024

missmesss commented Nov 21, 2024

jrichter1 Nov 25, 2024

missmesss Dec 12, 2024

Gerry-Forde commented Nov 28, 2024

missmesss commented Dec 12, 2024

hmanwani-rh commented Jan 6, 2025

missmesss commented Jan 6, 2025

Gerry-Forde Jan 7, 2025

HACDOCS-975: Adding JFrog Artifactory plugin content #714

Are you sure you want to change the base?

HACDOCS-975: Adding JFrog Artifactory plugin content #714

Conversation

missmesss commented Nov 15, 2024 • edited Loading

rhdh-bot commented Nov 15, 2024 • edited Loading

karthikjeeyar left a comment

Choose a reason for hiding this comment

openshift-ci bot commented Nov 19, 2024

missmesss commented Nov 21, 2024

missmesss commented Nov 21, 2024

jrichter1 Nov 25, 2024

Choose a reason for hiding this comment

missmesss Dec 12, 2024

Choose a reason for hiding this comment

Gerry-Forde commented Nov 28, 2024

missmesss commented Dec 12, 2024

hmanwani-rh commented Jan 6, 2025

missmesss commented Jan 6, 2025

Gerry-Forde Jan 7, 2025

Choose a reason for hiding this comment

missmesss commented Nov 15, 2024 •

edited

Loading

rhdh-bot commented Nov 15, 2024 •

edited

Loading