Skip to content

Commit 32d76ad

Browse files
Merge pull request #52711 from michaelryanpeter/OSDOCS-4533-CIT-Remove-xrefs-in-osdk-common-prereq.adoc
OSDOCS-4533: CIT Remove xrefs in module and clean up
2 parents 298131f + 6c1e7f9 commit 32d76ad

10 files changed

+72
-23
lines changed

modules/osdk-common-prereqs.adoc

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,24 +33,24 @@ endif::[]
3333
[id="osdk-common-prereqs_{context}"]
3434
= Prerequisites
3535

36-
- xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Operator SDK CLI installed]
37-
- xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[OpenShift CLI (`oc`) v{product-version}+ installed]
36+
* Operator SDK CLI installed
37+
* OpenShift CLI (`oc`) v{product-version}+ installed
3838
ifdef::golang[]
39-
- link:https://golang.org/dl/[Go] v1.18+
39+
* link:https://golang.org/dl/[Go] v1.18+
4040
endif::[]
4141
ifdef::ansible[]
42-
- link:https://docs.ansible.com/ansible/2.9/index.html[Ansible] v2.9.0
43-
- link:https://ansible-runner.readthedocs.io/en/latest/install.html[Ansible Runner] v2.0.2+
44-
- link:https://github.com/ansible/ansible-runner-http[Ansible Runner HTTP Event Emitter plug-in] v1.0.0+
45-
- link:https://www.python.org/downloads/[Python] 3.8.6+
46-
- link:https://pypi.org/project/openshift/[OpenShift Python client] v0.12.0+
42+
* link:https://docs.ansible.com/ansible/2.9/index.html[Ansible] v2.9.0
43+
* link:https://ansible-runner.readthedocs.io/en/latest/install.html[Ansible Runner] v2.0.2+
44+
* link:https://github.com/ansible/ansible-runner-http[Ansible Runner HTTP Event Emitter plug-in] v1.0.0+
45+
* link:https://www.python.org/downloads/[Python] 3.8.6+
46+
* link:https://pypi.org/project/openshift/[OpenShift Python client] v0.12.0+
4747
endif::[]
4848
ifdef::java[]
49-
- link:https://java.com/en/download/help/download_options.html[Java] v11+
50-
- link:https://maven.apache.org/install.html[Maven] v3.6.3+
49+
* link:https://java.com/en/download/help/download_options.html[Java] v11+
50+
* link:https://maven.apache.org/install.html[Maven] v3.6.3+
5151
endif::[]
52-
- Logged into an {product-title} {product-version} cluster with `oc` with an account that has `cluster-admin` permissions
53-
- To allow the cluster to pull the image, the repository where you push your image must be set as public, or you must configure an image pull secret
52+
* Logged into an {product-title} {product-version} cluster with `oc` with an account that has `cluster-admin` permissions
53+
* To allow the cluster to pull the image, the repository where you push your image must be set as public, or you must configure an image pull secret
5454

5555
ifeval::["{context}" == "osdk-ansible-quickstart"]
5656
:!ansible:

operators/operator_sdk/ansible/osdk-ansible-quickstart.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ The Operator SDK includes options for generating an Operator project that levera
1111
To demonstrate the basics of setting up and running an link:https://docs.ansible.com/ansible/latest/index.html[Ansible]-based Operator using tools and libraries provided by the Operator SDK, Operator developers can build an example Ansible-based Operator for Memcached, a distributed key-value store, and deploy it to a cluster.
1212

1313
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
.Additional resources
17+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
18+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
19+
1420
include::modules/osdk-quickstart.adoc[leveloffset=+1]
1521

1622
[id="osdk-ansible-quickstart-next-steps"]

operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ This tutorial goes into greater detail than xref:../../../operators/operator_sdk
2525

2626
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
2727

28+
[role="_additional-resources"]
29+
.Additional resources
30+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
31+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
32+
2833
include::modules/osdk-create-project.adoc[leveloffset=+1]
2934
include::modules/osdk-project-file.adoc[leveloffset=+2]
3035

@@ -48,5 +53,5 @@ include::modules/osdk-create-cr.adoc[leveloffset=+1]
4853
[id="osdk-ansible-tutorial-addtl-resources"]
4954
== Additional resources
5055

51-
- See xref:../../../operators/operator_sdk/ansible/osdk-ansible-project-layout.adoc#osdk-ansible-project-layout[Project layout for Ansible-based Operators] to learn about the directory structures created by the Operator SDK.
52-
- If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).
56+
* See xref:../../../operators/operator_sdk/ansible/osdk-ansible-project-layout.adoc#osdk-ansible-project-layout[Project layout for Ansible-based Operators] to learn about the directory structures created by the Operator SDK.
57+
* If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).

operators/operator_sdk/golang/osdk-golang-quickstart.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ toc::[]
99
To demonstrate the basics of setting up and running a Go-based Operator using tools and libraries provided by the Operator SDK, Operator developers can build an example Go-based Operator for Memcached, a distributed key-value store, and deploy it to a cluster.
1010

1111
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
12+
13+
[role="_additional-resources"]
14+
.Additional resources
15+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
16+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
17+
1218
include::modules/osdk-quickstart.adoc[leveloffset=+1]
1319

1420
[id="osdk-golang-quickstart-next-steps"]

operators/operator_sdk/golang/osdk-golang-tutorial.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,11 @@ This tutorial goes into greater detail than xref:../../../operators/operator_sdk
2121

2222
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
2323

24+
[role="_additional-resources"]
25+
.Additional resources
26+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
27+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
28+
2429
include::modules/osdk-create-project.adoc[leveloffset=+1]
2530
include::modules/osdk-project-file.adoc[leveloffset=+2]
2631
include::modules/osdk-golang-manager.adoc[leveloffset=+2]
@@ -57,5 +62,5 @@ include::modules/osdk-create-cr.adoc[leveloffset=+1]
5762
[role="_additional-resources"]
5863
== Additional resources
5964

60-
- See xref:../../../operators/operator_sdk/golang/osdk-golang-project-layout.adoc#osdk-golang-project-layout[Project layout for Go-based Operators] to learn about the directory structures created by the Operator SDK.
61-
- If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).
65+
* See xref:../../../operators/operator_sdk/golang/osdk-golang-project-layout.adoc#osdk-golang-project-layout[Project layout for Go-based Operators] to learn about the directory structures created by the Operator SDK.
66+
* If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).

operators/operator_sdk/helm/osdk-helm-quickstart.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ The Operator SDK includes options for generating an Operator project that levera
1111
To demonstrate the basics of setting up and running an link:https://helm.sh/docs/[Helm]-based Operator using tools and libraries provided by the Operator SDK, Operator developers can build an example Helm-based Operator for Nginx and deploy it to a cluster.
1212

1313
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
.Additional resources
17+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
18+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
19+
1420
include::modules/osdk-quickstart.adoc[leveloffset=+1]
1521

1622
[id="osdk-helm-quickstart-next-steps"]

operators/operator_sdk/helm/osdk-helm-tutorial.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,11 @@ This tutorial goes into greater detail than xref:../../../operators/operator_sdk
2525

2626
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
2727

28+
[role="_additional-resources"]
29+
.Additional resources
30+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
31+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
32+
2833
include::modules/osdk-create-project.adoc[leveloffset=+1]
2934
include::modules/osdk-helm-existing-chart.adoc[leveloffset=+2]
3035
include::modules/osdk-project-file.adoc[leveloffset=+2]
@@ -50,5 +55,5 @@ include::modules/osdk-create-cr.adoc[leveloffset=+1]
5055
[role="_additional-resources"]
5156
== Additional resources
5257

53-
- See xref:../../../operators/operator_sdk/helm/osdk-helm-project-layout.adoc#osdk-helm-project-layout[Project layout for Helm-based Operators] to learn about the directory structures created by the Operator SDK.
54-
- If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).
58+
* See xref:../../../operators/operator_sdk/helm/osdk-helm-project-layout.adoc#osdk-helm-project-layout[Project layout for Helm-based Operators] to learn about the directory structures created by the Operator SDK.
59+
* If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).

operators/operator_sdk/helm/osdk-hybrid-helm.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,17 @@ include::snippets/technology-preview.adoc[]
1818

1919
This tutorial walks through the following process using the Hybrid Helm Operator:
2020

21-
- Create a `Memcached` deployment through a Helm chart if it does not exist
22-
- Ensure that the deployment size is the same as specified by `Memcached` custom resource (CR) spec
23-
- Create a `MemcachedBackup` deployment by using the Go API
21+
* Create a `Memcached` deployment through a Helm chart if it does not exist
22+
* Ensure that the deployment size is the same as specified by `Memcached` custom resource (CR) spec
23+
* Create a `MemcachedBackup` deployment by using the Go API
2424
2525
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
2626

27+
[role="_additional-resources"]
28+
.Additional resources
29+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
30+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
31+
2732
include::modules/osdk-hh-create-project.adoc[leveloffset=+1]
2833
.Additional resources
2934

operators/operator_sdk/java/osdk-java-quickstart.adoc

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,12 @@ toc::[]
1111
To demonstrate the basics of setting up and running a Java-based Operator using tools and libraries provided by the Operator SDK, Operator developers can build an example Java-based Operator for Memcached, a distributed key-value store, and deploy it to a cluster.
1212

1313
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
14+
15+
[role="_additional-resources"]
16+
.Additional resources
17+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
18+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
19+
1420
include::modules/osdk-quickstart.adoc[leveloffset=+1]
1521

1622
[id="next-steps_osdk-java-quickstart"]

operators/operator_sdk/java/osdk-java-tutorial.adoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,11 @@ This tutorial goes into greater detail than xref:../../../operators/operator_sdk
2323

2424
include::modules/osdk-common-prereqs.adoc[leveloffset=+1]
2525

26+
[role="_additional-resources"]
27+
.Additional resources
28+
* xref:../../../operators/operator_sdk/osdk-installing-cli.adoc#osdk-installing-cli[Installing the Operator SDK CLI]
29+
* xref:../../../cli_reference/openshift_cli/getting-started-cli.adoc#getting-started-cli[Getting started with the OpenShift CLI]
30+
2631
include::modules/osdk-create-project.adoc[leveloffset=+1]
2732
include::modules/osdk-project-file.adoc[leveloffset=+2]
2833

@@ -53,5 +58,5 @@ include::modules/osdk-deploy-olm.adoc[leveloffset=+3]
5358
[id="additional-resources_osdk-java-tutorial"]
5459
== Additional resources
5560

56-
- See xref:../../../operators/operator_sdk/java/osdk-java-project-layout.adoc#osdk-java-project-layout[Project layout for Java-based Operators] to learn about the directory structures created by the Operator SDK.
57-
- If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).
61+
* See xref:../../../operators/operator_sdk/java/osdk-java-project-layout.adoc#osdk-java-project-layout[Project layout for Java-based Operators] to learn about the directory structures created by the Operator SDK.
62+
* If a xref:../../../networking/enable-cluster-wide-proxy.adoc#enable-cluster-wide-proxy[cluster-wide egress proxy is configured], cluster administrators can xref:../../../operators/admin/olm-configuring-proxy-support.adoc#olm-configuring-proxy-support[override the proxy settings or inject a custom CA certificate] for specific Operators running on Operator Lifecycle Manager (OLM).

0 commit comments

Comments
 (0)