Skip to content

Commit 1bd4f49

Browse files
authored
RHIDP-8565 fixed the Vale alert: AsciiDocDITA.RelatedLinks:Content other than links cannot be mapped to DITA related-links. (#1368)
1 parent 6b4c762 commit 1bd4f49

File tree

7 files changed

+46
-43
lines changed

7 files changed

+46
-43
lines changed

assemblies/assembly-install-rhdh-airgapped-environment-ocp-helm.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33

44
You can install {product} in a fully disconnected or partially disconnected environment using the {product} Helm chart.
55

6-
[role="_additional-resources"]
7-
.Additional resources
8-
* For more information about registry authentication, see link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication].
9-
106
include::modules/installation/proc-install-rhdh-helm-airgapped-full.adoc[leveloffset=+1]
117

128
include::modules/installation/proc-install-rhdh-helm-airgapped-partial.adoc[leveloffset=+1]
9+
10+
[role="_additional-resources"]
11+
.Additional resources
12+
* link:https://access.redhat.com/articles/RegistryAuthentication[{company-name} Container Registry Authentication]

assemblies/assembly-install-rhdh-eks-operator.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
The {product} Operator installation requires the Operator Lifecycle Manager (OLM) framework.
66

7+
include::modules/installation/proc-rhdh-deploy-eks-operator.adoc[leveloffset=+1]
8+
79
.Additional resources
8-
* For information about the OLM, see link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)] documentation.
10+
* link:https://olm.operatorframework.io/docs/[Operator Lifecycle Manager(OLM)]
911
10-
include::modules/installation/proc-rhdh-deploy-eks-operator.adoc[leveloffset=+1]

modules/about/con-benefits-of-rhdh.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,12 @@ For organizations::
2626
== Key features
2727

2828
Centralized Dashboard::
29-
Provides a single interface for accessing developer tools, CI/CD pipelines, APIs, monitoring tools, and documentation. Integrated with systems like Git, OpenShift, Kubernetes, and JIRA.
29+
Provides a single interface for accessing developer tools, CI/CD pipelines, APIs, monitoring tools, and documentation.
30+
Integrated with systems like Git, OpenShift, Kubernetes, and JIRA.
3031

3132
Dynamic Plugins::
32-
Add, update, or remove plugins dynamically without downtime. Popular plugins like Tekton, GitOps, Nexus Repository, and JFrog Artifactory are supported and verified by Red Hat.
33+
Add, update, or remove plugins dynamically without downtime.
34+
Popular plugins like Tekton, GitOps, Nexus Repository, and JFrog Artifactory are supported and verified by Red Hat.
3335

3436
Software Templates::
3537
Simplify development processes by automating tasks such as repository setup, variable insertion, and production pipeline creation.
@@ -45,4 +47,4 @@ Centralized repositories ensure synchronized updates, improving version control
4547

4648
[role="_additional-resources"]
4749
.Additional resources
48-
* For more information about the different features of {product} and how to extend it, see link:https://developers.redhat.com/rhdh/overview[{product} overview].
50+
* link:https://developers.redhat.com/rhdh/overview[{product} overview]

modules/configuring-deployment/proc-configuring-deployment-by-using-the-operator.adoc

Lines changed: 14 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
[id="configuring-the-deployment"]
22
= Configuring {product} deployment when using the Operator
33

4-
The {product} Operator exposes a `rhdh.redhat.com/v1alpha3` API Version of its custom resource (CR). This CR exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource. This field can be a fragment of the standard `apps.Deployment` Kubernetes object.
4+
The {product} Operator exposes a `rhdh.redhat.com/v1alpha3` API Version of its custom resource (CR).
5+
This CR exposes a generic `spec.deployment.patch` field, which gives you full control over the {product-short} Deployment resource.
6+
This field can be a fragment of the standard `apps.Deployment` Kubernetes object.
57

68
.Procedure
7-
89
. Create a `{product-custom-resource-type}` CR with the following fields:
910

1011
--
1112
.Example
12-
[source, yaml]
13+
[source,yaml]
1314
----
1415
apiVersion: rhdh.redhat.com/v1alpha3
1516
kind: Backstage
@@ -26,7 +27,7 @@ spec:
2627
Add labels to the {product-short} pod.
2728
+
2829
.Example adding the label `my=true`
29-
[source, yaml]
30+
[source,yaml]
3031
----
3132
apiVersion: rhdh.redhat.com/v1alpha3
3233
kind: Backstage
@@ -45,10 +46,11 @@ spec:
4546
`volumes`::
4647
+
4748
--
49+
4850
Add an additional volume named `my-volume` and mount it under `/my/path` in the {product-short} application container.
4951

5052
.Example additional volume
51-
[source, yaml]
53+
[source,yaml]
5254
----
5355
apiVersion: rhdh.redhat.com/v1alpha3
5456
kind: Backstage
@@ -73,10 +75,11 @@ spec:
7375
name: my-volume
7476
----
7577

76-
Replace the default `dynamic-plugins-root` volume with a persistent volume claim (PVC) named `dynamic-plugins-root`. Note the `$patch: replace` directive, otherwise a new volume will be added.
78+
Replace the default `dynamic-plugins-root` volume with a persistent volume claim (PVC) named `dynamic-plugins-root`.
79+
Note the `$patch: replace` directive, otherwise a new volume will be added.
7780

7881
.Example `dynamic-plugins-root` volume replacement
79-
[source, yaml]
82+
[source,yaml]
8083
----
8184
apiVersion: rhdh.redhat.com/v1alpha3
8285
kind: Backstage
@@ -94,14 +97,15 @@ spec:
9497
persistentVolumeClaim:
9598
claimName: dynamic-plugins-root
9699
----
100+
97101
--
98102

99103
`cpu` request::
100104

101105
Set the CPU request for the {product-short} application container to 250m.
102106
+
103107
.Example CPU request
104-
[source, yaml]
108+
[source,yaml]
105109
----
106110
apiVersion: rhdh.redhat.com/v1alpha3
107111
kind: Backstage
@@ -125,7 +129,7 @@ spec:
125129
Add a new `my-sidecar` sidecar container into the {product-short} Pod.
126130
+
127131
.Example side car container
128-
[source, yaml]
132+
[source,yaml]
129133
----
130134
apiVersion: rhdh.redhat.com/v1alpha3
131135
kind: Backstage
@@ -146,5 +150,4 @@ spec:
146150

147151
[role="_additional-resources"]
148152
.Additional resources
149-
150-
* To learn more about merging, see link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format[Strategic Merge Patch].
153+
* link:https://github.com/kubernetes/community/blob/master/contributors/devel/sig-api-machinery/strategic-merge-patch.md#basic-patch-format[Strategic Merge Patch]

modules/customizing-the-learning-paths/proc-customizing-the-learning-paths-by-using-hosted-json-files.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44
For ease of use and simplicity, you can configure the Learning Paths by using a hosted JSON file.
55

66
.Procedure
7-
. Publish the JSON file containing your Learning Paths data to a web server, such as GitHub or Gitlab. You can find an example at link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/learning-paths/data.json[].
7+
. Publish the JSON file containing your Learning Paths data to a web server, such as GitHub or Gitlab.
8+
You can find an example at link:https://raw.githubusercontent.com/redhat-developer/rhdh/release-{product-version}/packages/app/public/learning-paths/data.json[].
89

910
. Configure the {product-short} proxy to access the Learning Paths data from the hosted JSON file, by adding the following to the `{my-app-config-file}` file:
1011
+
@@ -22,8 +23,7 @@ proxy:
2223

2324
`_<target>_`:: Enter the hosted JSON file base URL, such as `pass:[https://raw.githubusercontent.com]`.
2425

25-
`_<learning_path.json>_`:: Enter the hosted JSON file path without the base URL, such as
26-
`'/redhat-developer/rhdh/main/packages/app/public/learning-paths/data.json'`
26+
`_<learning_path.json>_`:: Enter the hosted JSON file path without the base URL, such as `'/redhat-developer/rhdh/main/packages/app/public/learning-paths/data.json'`
2727
+
2828
[TIP]
2929
====
@@ -46,4 +46,4 @@ proxy:
4646
====
4747

4848
.Additional resources
49-
* xref:customizing-the-home-page[Customizing the Home page in {product}].
49+
* xref:customizing-the-home-page[Customizing the Home page in {product}]

modules/dynamic-plugins/proc-enabling-argo-cd-rollouts.adoc

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22
[id="enabling-argo-cd-rollouts_{context}"]
33
= Enabling Argo CD Rollouts
44

5-
The optional Argo CD Rollouts feature enhances Kubernetes by providing advanced deployment strategies, such as blue-green and canary deployments, for your applications. When integrated into the backstage Kubernetes plugin, it allows developers and operations teams to visualize and manage Argo CD Rollouts seamlessly within the {product-custom-resource-type} interface.
5+
The optional Argo CD Rollouts feature enhances Kubernetes by providing advanced deployment strategies, such as blue-green and canary deployments, for your applications.
6+
When integrated into the backstage Kubernetes plugin, it allows developers and operations teams to visualize and manage Argo CD Rollouts seamlessly within the {product-custom-resource-type} interface.
67

78
.Prerequisites
8-
9-
* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured.
9+
* The Backstage Kubernetes plugin (`@backstage/plugin-kubernetes`) is installed and configured.
1010
1111
** To install and configure Kubernetes plugin in Backstage, see link:https://backstage.io/docs/features/kubernetes/installation/[Installaltion] and link:https://backstage.io/docs/features/kubernetes/configuration/[Configuration] guide.
1212

@@ -15,7 +15,6 @@ The optional Argo CD Rollouts feature enhances Kubernetes by providing advanced
1515
* The Kubernetes cluster has the `argoproj.io` group resources (for example, Rollouts and AnalysisRuns) installed.
1616
1717
.Procedure
18-
1918
. In the `{my-app-config-file}` file in your {product-custom-resource-type} instance, add the following `customResources` component under the `kubernetes` configuration to enable Argo Rollouts and AnalysisRuns:
2019

2120
+
@@ -103,7 +102,8 @@ annotations:
103102
+
104103
[NOTE]
105104
====
106-
Ensure you specify the labels declared in `backstage.io/kubernetes-label-selector` on your Kubernetes resources. This annotation overrides entity-based or namespace-based identification annotations, such as `backstage.io/kubernetes-id` and `backstage.io/kubernetes-namespace`.
105+
Ensure you specify the labels declared in `backstage.io/kubernetes-label-selector` on your Kubernetes resources.
106+
This annotation overrides entity-based or namespace-based identification annotations, such as `backstage.io/kubernetes-id` and `backstage.io/kubernetes-namespace`.
107107
====
108108

109109
. Add label to Kubernetes resources to enable Backstage to find the appropriate Kubernetes resources.
@@ -129,16 +129,17 @@ labels:
129129
+
130130
[NOTE]
131131
====
132-
If using the label selector annotation (backstage.io/kubernetes-label-selector), ensure the specified labels are present on the resources. The label selector will override other annotations like kubernetes-id or kubernetes-namespace.
132+
If using the label selector annotation (backstage.io/kubernetes-label-selector), ensure the specified labels are present on the resources.
133+
The label selector will override other annotations like kubernetes-id or kubernetes-namespace.
133134
====
134135

135136
.Verification
136-
137137
. Push the updated configuration to your GitOps repository to trigger a rollout.
138138

139139
. Open {product} interface and navigate to the entity you configured.
140140

141-
. Select the *CD* tab and then select the *GitOps application*. The side panel opens.
141+
. Select the *CD* tab and then select the *GitOps application*.
142+
The side panel opens.
142143

143144
. In the *Resources* table of the side panel, verify that the following resources are displayed:
144145

@@ -155,7 +156,4 @@ If using the label selector annotation (backstage.io/kubernetes-label-selector),
155156
156157
[role="_additional-resources"]
157158
.Additional resources
158-
159-
* The package path, scope, and name of the {company-name} ArgoCD plugin has changed since 1.2. For more information, see link:{release-notes-book-url}#removed-functionality-rhidp-4293[Breaking Changes] in the _{release-notes-book-title}_.
160-
161-
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
159+
* link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,15 @@
11
= Using the Argo CD plugin
22

3-
You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflows in OpenShift GitOps. This plugin provides a visual overview of the application’s status, deployment details, commit message, author of the commit, container image promoted to environment and deployment history.
3+
You can use the Argo CD plugin to visualize the Continuous Delivery (CD) workflows in OpenShift GitOps.
4+
This plugin provides a visual overview of the application’s status, deployment details, commit message, author of the commit, container image promoted to environment and deployment history.
45

56
.Prerequisites
6-
77
* You have enabled the Argo CD plugin in {product} {product-very-short}.
88
99
.Procedure
10-
1110
. Select the *Catalog* tab and choose the component that you want to use.
1211

13-
. Select the *CD* tab to view insights into deployments managed by Argo CD.
12+
. Select the *CD* tab to view insights into deployments managed by Argo CD.
1413

1514
+
1615
image::rhdh-plugins-reference/argocd.png[CD tab Argo CD]
@@ -22,13 +21,13 @@ image::rhdh-plugins-reference/sidebar.png[Sidebar]
2221

2322
.. Click the link icon (image:rhdh-plugins-reference/link.png[Link icon]) to open the deployment details in Argo CD.
2423

25-
. Select the *Overview* tab and navigate to the Deployment summary section to review the summary of your application's deployment across namespaces. Additionally, select an appropriate Argo CD app to open the deployment details in Argo CD, or select a commit ID from the Revision column to review the changes in GitLab or GitHub.
24+
. Select the *Overview* tab and navigate to the Deployment summary section to review the summary of your application's deployment across namespaces.
25+
Additionally, select an appropriate Argo CD app to open the deployment details in Argo CD, or select a commit ID from the Revision column to review the changes in GitLab or GitHub.
2626

2727
+
2828
image::rhdh-plugins-reference/deployment_summary.png[Deployment summary]
2929

3030

3131
[role="_additional-resources"]
3232
.Additional resources
33-
34-
* For more information on installing dynamic plugins, see link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}].
33+
* link:{installing-and-viewing-plugins-book-url}[{installing-and-viewing-plugins-book-title}]

0 commit comments

Comments
 (0)