Skip to content

Commit 7be8099

Browse files
authored
Merge pull request #65586 from aireilly/typo-fixes
OCPBUGS-19984 - typo fixes in ZTP docs
2 parents 666ba8f + ea91351 commit 7be8099

File tree

2 files changed

+29
-31
lines changed

2 files changed

+29
-31
lines changed

modules/ztp-preparing-the-hub-cluster-for-ztp.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@ $ oc patch argocd openshift-gitops \
5050
5151
. In {rh-rhacm} 2.7 and later, the multicluster engine enables the `cluster-proxy-addon` feature by default.
5252
To disable this feature, apply the following patch to disable and remove the relevant hub cluster and managed cluster pods that are responsible for this add-on.
53-
53+
Run the following command:
54+
+
5455
[source,terminal]
5556
----
5657
$ oc patch multiclusterengines.multicluster.openshift.io multiclusterengine --type=merge --patch-file out/argocd/deployment/disable-cluster-proxy-addon.json

modules/ztp-preparing-the-ztp-git-repository.adoc

Lines changed: 27 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Before you can use the {ztp-first} pipeline, you need to prepare the Git reposit
2020
+
2121
[NOTE]
2222
====
23-
Keep `SiteConfig` and `PolicyGenTemplate` CRs in separate directories.
23+
Keep `SiteConfig` and `PolicyGenTemplate` CRs in separate directories.
2424
Both the `SiteConfig` and `PolicyGenTemplate` directories must contain a `kustomization.yaml` file that explicitly includes the files in that directory.
2525
====
2626

@@ -54,24 +54,21 @@ $ podman run --log-driver=none --rm registry.redhat.io/openshift4/ztp-site-gener
5454

5555
. The out/extra-manifests directory contains the reference manifests for a RAN DU cluster.
5656
Copy the `out/extra-manifests` directory into the `SiteConfig` folder.
57-
This directory should contain CRs from the `ztp-site-generate` container only.
57+
This directory should contain CRs from the `ztp-site-generate` container only.
5858
Do not add custom CRs here.
59-
If you want to work with custom CRs you must create another directory for that content.
59+
If you want to work with custom CRs you must create another directory for that content.
60+
For example:
6061
+
61-
[NOTE]
62-
====
63-
Here is an example of the directory structure:
64-
source,text]
62+
[source,text]
6563
----
66-
example
67-
├── policygentemplates
68-
│ ├── kustomization.yaml
69-
│ └── source-crs/
70-
└── siteconfig
71-
├── extra-manifests
72-
└── kustomization.yaml
64+
example/
65+
├── policygentemplates
66+
│ ├── kustomization.yaml
67+
│ └── source-crs/
68+
└── siteconfig
69+
├── extra-manifests
70+
└── kustomization.yaml
7371
----
74-
====
7572

7673
. Commit the directory structure and the `kustomization.yaml` files and push to your Git repository.
7774
The initial push to Git should include the `kustomization.yaml` files.
@@ -89,21 +86,21 @@ The following example describes a set of CRs for a network of single-node cluste
8986

9087
[source,text]
9188
----
92-
example
93-
├── policygentemplates
94-
│ ├── common-ranGen.yaml
95-
│ ├── example-sno-site.yaml
96-
│ ├── group-du-sno-ranGen.yaml
97-
│ ├── group-du-sno-validator-ranGen.yaml
98-
│ ├── kustomization.yaml
99-
│ ├── source-crs/
100-
│ └── ns.yaml
101-
└── siteconfig
102-
├── example-sno.yaml
103-
├── extra-manifests/ <1>
104-
├── custom-manifests/ <2>
105-
├── KlusterletAddonConfigOverride.yaml
106-
└── kustomization.yaml
89+
example/
90+
├── policygentemplates
91+
│ ├── common-ranGen.yaml
92+
│ ├── example-sno-site.yaml
93+
│ ├── group-du-sno-ranGen.yaml
94+
│ ├── group-du-sno-validator-ranGen.yaml
95+
│ ├── kustomization.yaml
96+
│ ├── source-crs/
97+
│ └── ns.yaml
98+
└── siteconfig
99+
├── example-sno.yaml
100+
├── extra-manifests/ <1>
101+
├── custom-manifests/ <2>
102+
├── KlusterletAddonConfigOverride.yaml
103+
└── kustomization.yaml
107104
----
108105
<1> Contains reference manifests from the `ztp-container`.
109106
<2> Contains custom manifests.

0 commit comments

Comments
 (0)