Skip to content

Commit 9f445ee

Browse files
authored
Merge branch 'main' into RHIDP-8196
2 parents 2a27aa3 + f63aac6 commit 9f445ee

File tree

62 files changed

+1676
-87
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+1676
-87
lines changed

artifacts/attributes.adoc

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,7 @@
6565
:rhdeveloper-name: Red Hat Developer
6666
:rhel: Red Hat Enterprise Linux
6767
:rhoai-brand-name: Red Hat OpenShift AI
68+
:rhoai-short: RHOAI
6869
:rhoserverless-brand-name: Red Hat OpenShift Serverless
6970
:rhsso-brand-name: Red Hat Single-Sign On
7071
:rhsso: RHSSO
@@ -168,9 +169,19 @@
168169
:upgrading-book-title: Upgrading {product}
169170
:using-dynamic-plugins-book-link: {product-docs-link}/html-single/installing_and_viewing_plugins_in_red_hat_developer_hub/index
170171
:using-dynamic-plugins-book-title: Using dynamic plugins
172+
:plugin-type-name: custom
173+
:plugin-type-name-uppercase: Custom
174+
171175

172176
:scorecard-plugin-book-link: {product-docs-link}/html-single/understand_and_visualize_red_hat_developer_hub_project_health_using_scorecards/index
173177
:scorecard-plugin-book-title: Understand and visualize {product} project health using Scorecards
174178

175179
:model-context-protocol-link: {product-docs-link}/html-single/interacting_with_model_context_protocol_tools_for_red_hat_developer_hub/index
176180
:model-context-protocol-title: Interacting with Model Context Protocol tools for {product}
181+
182+
:openshift-ai-connector-for-rhdh-link: {product-docs-link}/html-single/accelerate_ai_development_with_openshift_ai_connector_for_red_hat_developer_hub/index
183+
184+
:openshift-ai-connector-name: OpenShift AI Connector for {product}
185+
:openshift-ai-connector-name-short: OpenShift AI Connector for {product-very-short}
186+
187+
:rhoai-docs-link: link:https://docs.redhat.com/en/documentation/red_hat_openshift_ai_self-managed/2.25/html-single
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
[IMPORTANT]
2+
====
3+
This section describes Developer Preview features in the {openshift-ai-connector-name} plugin. Developer Preview features are not supported by Red Hat in any way and are not functionally complete or production-ready. Do not use Developer Preview features for production or business-critical workloads. Developer Preview features provide early access to functionality in advance of possible inclusion in a Red Hat product offering. Customers can use these features to test functionality and provide feedback during the development process. Developer Preview features might not have any documentation, are subject to change or removal at any time, and have received limited testing. Red Hat might provide ways to submit feedback on Developer Preview features without an associated SLA.
4+
5+
For more information about the support scope of Red Hat Developer Preview features, see https://access.redhat.com/support/offerings/devpreview/[Developer Preview Support Scope].
6+
====
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="authentication-troubleshooting"]
4+
5+
= Troubleshooting authentication issues
6+
7+
Learn how to troubleshoot authentication issues.
8+
9+
include::modules/authentication/proc-reducing-token-size.adoc[leveloffset=+1]

assemblies/assembly-customizing-the-homepage.adoc

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,23 @@
44
[id="{context}"]
55
= Customizing the Home page
66

7-
When using the `app-config`, you can do the following:
7+
When using your {product-very-short} `{my-app-config-file}` file, you can do any of the following tasks:
88

99
* Customize and extend the default Home page layout with additional cards that appear based on the plugins you have installed and enabled.
1010
* Change quick access links.
11-
* Add, reorganize, and remove the following available cards:
12-
+
13-
** Search bar
14-
** Quick access
15-
** Headline
16-
** Markdown
17-
** Placeholder
18-
** Catalog starred entities
19-
** Featured docs
11+
* Add, reorganize, and remove the available homepage cards.
12+
13+
14+
include::modules/customizing-the-home-page/con-rhdh-available-cards.adoc[leveloffset=+1]
15+
2016

2117
include::modules/customizing-the-home-page/proc-customizing-the-home-page-cards.adoc[leveloffset=+1]
2218

2319

2420
include::modules/customizing-the-home-page/proc-defining-the-layout-of-the-product-home-page.adoc[leveloffset=+1]
2521

2622

27-
include::modules/customizing-the-home-page/proc-customizing-the-home-page.adoc[leveloffset=+1]
23+
include::modules/customizing-the-home-page/proc-customizing-the-home-page.adoc[leveloffset=+1]
24+
25+
26+
include::modules/customizing-the-home-page/proc-customizing-quickaccess-card-icons-on-the-rhdh-homepage.adoc[leveloffset=+1]

assemblies/assembly-enabling-authentication.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,5 @@ include::assembly-enabling-authentication-with-github.adoc[leveloffset=+1]
1818

1919
include::modules/authentication/proc-enabling-user-authentication-with-microsoft-azure-with-optional-steps.adoc[leveloffset=+1]
2020

21+
include::assembly-authentication-troubleshooting.adoc[leveloffset=+1]
22+
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-helm_{context}"]
4+
= Installing Orchestrator plugin in an air-gapped environment with the Helm chart
5+
6+
You can configure {product} ({product-very-short}) with the Orchestrator plugin in a fully disconnected or partially disconnected environment by using the Helm chart.
7+
8+
include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-full.adoc[leveloffset=+1]
9+
10+
include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-helm-chart-partial.adoc[leveloffset=+1]
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
[id="assembly-install-rhdh-orchestrator-plugin-in-an-air-gapped-environment-operator_{context}"]
4+
= Installing Orchestrator plugin in an air-gapped environment with the Operator
5+
6+
You can configure {product} ({product-very-short}) with the Orchestrator plugin in a fully disconnected or partially disconnected environment by using the Operator.
7+
8+
include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-full.adoc[leveloffset=+1]
9+
10+
include::modules/orchestrator/proc-install-rhdh-orchestrator-airgapped-env-using-operator-partial.adoc[leveloffset=+1]
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:_mod-docs-content-type: ASSEMBLY
2+
3+
= Extending {product} with custom plugins
4+
5+
You can extend {product} with your own custom plugins. However, to add a custom plugin to the {product} pre-built container image, you must bundle and install your custom plugin as a dynamic plugin.
6+
7+
To integrate a custom plugin into {product-short}, complete the following steps:
8+
9+
. First, obtain the plugin's source code.
10+
. Export the plugin as a dynamic plugin package.
11+
. Package and publish the dynamic plugin.
12+
. Install the plugin in the {product-short} environment.
13+
14+
[NOTE]
15+
====
16+
Standard {product-custom-resource-type} deployments statically compile plugins into the application itself. {product} supports dynamic plugins, meaning you can add plugins to an existing instance without recompiling the underlying {product-custom-resource-type} application.
17+
====
18+
19+
include::../modules/dynamic-plugins/con-custom-plugin-conversion.adoc[leveloffset=+1]
20+
21+
include::../modules/dynamic-plugins/proc-custom-plugin-conversion.adoc[leveloffset=+1]
22+
23+
include::../modules/dynamic-plugins/con-custom-plugin-add-to-rhdh.adoc[leveloffset=+1]
24+

assemblies/dynamic-plugins/assembly-install-third-party-plugins-rhdh.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: ASSEMBLY
22

33
[id="assembly-install-third-party-plugins-rhdh"]
4-
= Installing third-party plugins in {product}
4+
= Installing {plugin-type-name} plugins in {product}
55
:context: assembly-install-third-party-plugins-rhdh
66

7-
You can install a third-party plugins in {product} without rebuilding the {product-very-short} application.
7+
You can install a {plugin-type-name} plugins in {product} without rebuilding the {product-very-short} application.
88

99
The location of the `dynamic-plugin-config.yaml` file depends on the deployment method. For more details, refer to xref:proc-config-dynamic-plugins-rhdh-operator_rhdh-installing-rhdh-plugins[Installing dynamic plugins with the {product} Operator] and xref:con-install-dynamic-plugin-helm_rhdh-installing-rhdh-plugins[Installing dynamic plugins using the Helm chart].
1010

@@ -30,5 +30,5 @@ include::../modules/dynamic-plugins/proc-load-plugin-tgz-file.adoc[leveloffset=+
3030
include::../modules/dynamic-plugins/proc-load-plugin-js-package.adoc[leveloffset=+2]
3131

3232
//example third-party plugin installation
33-
include::../modules/dynamic-plugins/proc-example-third-party-plugin-installation.adoc[leveloffset=+2]
33+
//include::../modules/dynamic-plugins/proc-example-third-party-plugin-installation.adoc[leveloffset=+2]
3434

assemblies/dynamic-plugins/assembly-package-publish-third-party-dynamic-plugin.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
:_mod-docs-content-type: ASSEMBLY
22

33
[id="assembly-package-publish-third-party-dynamic-plugin"]
4-
= Packaging and publishing third-party plugins as dynamic plugins
4+
= Packaging and publishing {plugin-type-name} plugins as dynamic plugins
55
:context: assembly-package-publish-third-party-dynamic-plugin
66

7-
After xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[exporting a third-party plugin], you can package the derived package into one of the following supported formats:
7+
After xref:proc-export-third-party-plugins-rhdh_assembly-third-party-plugins[exporting a {plugin-type-name} plugin], you can package the derived package into one of the following supported formats:
88

99
* Open Container Initiative (OCI) image (recommended)
1010
* TGZ file

0 commit comments

Comments
 (0)