Skip to content

Commit dbaf609

Browse files
openshift-cherrypick-robotnickboldtrhdh-botGerry-Forde
authored
[release-1.3] feat: add doc about compatible plugins... (#551)
Co-authored-by: Nick Boldt <nboldt@redhat.com> Co-authored-by: rhdh-bot service account <rhdh-bot@redhat.com> Co-authored-by: Gerry-Forde <63045020+Gerry-Forde@users.noreply.github.com>
1 parent fdcf1b2 commit dbaf609

File tree

6 files changed

+65
-7
lines changed

6 files changed

+65
-7
lines changed

assemblies/dynamic-plugins/assembly-rhdh-installing-dynamic-plugins.adoc

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ include::../modules/dynamic-plugins/con-preinstalled-dynamic-plugins.adoc[levelo
2020
[id="rhdh-supported-plugins"]
2121
== Preinstalled dynamic plugin descriptions and details
2222

23-
// Red Hat supported plugins
23+
// Red Hat Generally Available supported plugins
2424
include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3]
2525

2626
[NOTE]
@@ -33,12 +33,24 @@ include::../modules/dynamic-plugins/ref-rh-supported-plugins.adoc[leveloffset=+3
3333
// Technology preview support statement
3434
include::../../artifacts/snip-dynamic-plugins-support.adoc[leveloffset=+3]
3535

36-
// Red Hat technology preview plugins
36+
// Red Hat Technology Preview plugins
37+
[id="rhdh-tech-preview-plugins"]
3738
include::../modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc[leveloffset=+4]
3839

40+
[NOTE]
41+
====
42+
* A new Technology Preview plugin for Red Hat Ansible Automation Platform (RHAAP) is available, which replaces this older one. See link:{LinkPluginsGuide}#rhdh-compatible-plugins[Other compatible plugins] in the _{NameOfPluginsGuide} guide_ for further details.
43+
====
44+
3945
// Community plugins
46+
[id="rhdh-community-plugins"]
4047
include::../modules/dynamic-plugins/ref-community-plugins.adoc[leveloffset=+4]
4148

49+
// Red Hat compatible plugins
50+
[id="rhdh-compatible-plugins"]
51+
include::../modules/dynamic-plugins/ref-rh-compatible-plugins.adoc[leveloffset=+1]
52+
53+
4254
// Configure dynamic plugins - moved from admin guide
4355
include::../modules/dynamic-plugins/proc-config-dynamic-plugins-rhdh-operator.adoc[leveloffset=+1]
4456

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
// This page is generated! Do not edit the .adoc file, but instead run rhdh-supported-plugins.sh to regen this page from the latest plugin metadata.
2+
// cd /path/to/rhdh-documentation; ./modules/dynamic-plugins/rhdh-supported-plugins.sh; ./build/scripts/build.sh; google-chrome titles-generated/main/plugin-rhdh/index.html
3+
4+
= Other compatible installable plugins
5+
6+
{product-very-short} provides Technology Preview support for the following compatible plugins, which are not preinstalled and must be enabled from an external source:
7+
8+
[%header,cols=5*]
9+
|===
10+
|*Name* |*Description*|*Plugin*|*Version* |*Installation Details*
11+
12+
|Ansible Automation Platform Frontend
13+
.3+|Ansible plug-ins for RHDH delivers an Ansible-specific portal experience with curated learning paths, push-button content creation, integrated development tools, and other opinionated resources.
14+
|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap]` |1.0.0
15+
.3+| https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/installing_ansible_plug-ins_for_red_hat_developer_hub[Learn more]
16+
17+
|Ansible Automation Platform
18+
| `https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-backstage-rhaap-backend]` |1.0.0
19+
20+
|Ansible Automation Platform Scaffolder Backend
21+
|`https://access.redhat.com/downloads/content/480/ver=2.4/rhel---9/2.4/x86_64/product-software[@ansible/plugin-scaffolder-backend-module-backstage-rhaap]` |1.0.0
22+
23+
24+
|Orchestrator Frontend
25+
.2+|Orchestrator brings serverless workflows into Red Hat Developer Hub, focusing on the journey for application migration to the cloud, on boarding developers, and user-made workflows of Backstage actions or external systems.
26+
|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator[@janus-idp/backstage-plugin-orchestrator]` |1.22.6
27+
.2+| https://www.parodos.dev/1.2-rc/docs/[Learn more]
28+
29+
|Orchestrator Backend
30+
|`https://www.npmjs.com/package/@janus-idp/backstage-plugin-orchestrator-backend-dynamic[@janus-idp/backstage-plugin-orchestrator-backend-dynamic]` |1.22.9
31+
32+
33+
|===
34+
35+
[NOTE]
36+
====
37+
38+
* The above Red Hat Ansible Automation Platform (RHAAP) plugins, can be used as a replacement for the older plugin listed in the link:{LinkPluginsGuide}#rhdh-tech-preview-plugins[Technology Preview plugins] section of the _{NameOfPluginsGuide} guide_.
39+
====
40+

modules/dynamic-plugins/ref-rh-tech-preview-plugins.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
[%header,cols=4*]
99
|===
1010
|*Name* |*Plugin* |*Version* |*Path and required variables*
11-
|AAP |`https://npmjs.com/package/@janus-idp/backstage-plugin-aap-backend/v/1.9.3[@janus-idp/backstage-plugin-aap-backend]` |1.9.3
11+
|Ansible Automation Platform (AAP) |`https://npmjs.com/package/@janus-idp/backstage-plugin-aap-backend/v/1.9.3[@janus-idp/backstage-plugin-aap-backend]` |1.9.3
1212
|`./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic`
1313

1414
`AAP_BASE_URL`

modules/dynamic-plugins/rhdh-supported-plugins.csv

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"Regex ","@janus-idp/backstage-scaffolder-backend-module-regex","Backend","1.7.1","Production","./dynamic-plugins/dist/janus-idp-backstage-scaffolder-backend-module-regex-dynamic",";","Enabled"
1515
"Tekton ","@janus-idp/backstage-plugin-tekton","Frontend","3.12.7","Production","./dynamic-plugins/dist/janus-idp-backstage-plugin-tekton",";","Disabled"
1616
"Topology ","@janus-idp/backstage-plugin-topology","Frontend","1.27.5","Production","./dynamic-plugins/dist/janus-idp-backstage-plugin-topology",";","Disabled"
17-
"AAP ","@janus-idp/backstage-plugin-aap-backend","Backend","1.9.3","Red Hat Tech Preview","./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic","`AAP_BASE_URL`;`AAP_AUTH_TOKEN`;","Disabled"
17+
"Ansible Automation Platform (AAP) ","@janus-idp/backstage-plugin-aap-backend","Backend","1.9.3","Red Hat Tech Preview","./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic","`AAP_BASE_URL`;`AAP_AUTH_TOKEN`;","Disabled"
1818
"ACR ","@janus-idp/backstage-plugin-acr","Frontend","1.7.11","Red Hat Tech Preview","./dynamic-plugins/dist/janus-idp-backstage-plugin-acr",";","Disabled"
1919
"Bulk Import ","@janus-idp/backstage-plugin-bulk-import","Frontend","1.4.9","Red Hat Tech Preview","./dynamic-plugins/dist/janus-idp-backstage-plugin-bulk-import",";","Disabled"
2020
"JFrog Artifactory ","@janus-idp/backstage-plugin-jfrog-artifactory","Frontend","1.7.5","Red Hat Tech Preview","./dynamic-plugins/dist/janus-idp-backstage-plugin-jfrog-artifactory",";","Disabled"

modules/dynamic-plugins/rhdh-supported-plugins.sh

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,9 @@ fi
6161
titlecase() {
6262
for f in ${*} ; do \
6363
case $f in
64+
aap) echo -n "Ansible Automation Platform (AAP) ";;
6465
# UPPERCASE these exceptions
65-
aap|acr|cd|ocm|rbac) echo -n "${f^^} ";;
66+
acr|cd|ocm|rbac) echo -n "${f^^} ";;
6667
# MixedCase exceptions
6768
argocd) echo -n "Argo CD ";;
6869
github) echo -n "GitHub ";;

modules/release-notes/con-relnotes-notable-features.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,11 @@ As an administrator, you can now use the {product-short} web interface to view a
5959
For more information, see the link:{LinkAdminGuide}#proc-viewing-installed-plugins[Viewing installed plugins] section in the _Administration guide_.
6060

6161

62-
== Supported plugins in {product} {product-version}
62+
== Available plugins in {product} {product-version}
6363

64-
To get a comprehensive list of supported dynamic plugins, see the link:{LinkAdminGuide}#rhdh-supported-plugins[Dynamic plugins included in {product}] section in the _Administration guide_.
64+
Available plugins are now split into multiple groups. See these sections in the _{NameOfPluginsGuide} guide_ for further details:
65+
66+
* link:{LinkPluginsGuide}#rhdh-supported-plugins[Red Hat Generally Available plugins]
67+
* link:{LinkPluginsGuide}#rhdh-tech-preview-plugins[Red Hat Technology Preview plugins]
68+
* link:{LinkPluginsGuide}#rhdh-community-plugins[Community plugins]
69+
* link:{LinkPluginsGuide}#rhdh-compatible-plugins[Other compatible plugins]

0 commit comments

Comments
 (0)