Skip to content

Commit d47a7b2

Browse files
JanakaSandaruwanLakshanSS
authored andcommitted
docs: fix prettier formatting and SR label key
Signed-off-by: Janaka Sandaruwan <janakasandaruwan1996@gmail.com>
1 parent 35bc085 commit d47a7b2

3 files changed

Lines changed: 10 additions & 7 deletions

File tree

docs/developer-guide/workflows/ci/private-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ flowchart LR
130130

131131
subgraph CP["Control Plane"]
132132
api["OpenChoreo<br/>API Server"]
133-
sr["SecretReference<br/>label: secret-type=git-credentials<br/>template.type: basic-auth<br/>targetPlane: ClusterWorkflowPlane"]
133+
sr["SecretReference<br/>label: openchoreo.dev/secret-type=git-credentials<br/>template.type: basic-auth<br/>targetPlane: ClusterWorkflowPlane"]
134134
wfrun["WorkflowRun"]
135135
end
136136

docs/platform-engineer-guide/secret-management.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,9 +207,12 @@ See the [CLI Reference](../reference/cli-reference.md#secret) for the full comma
207207
4. Enter the key/value pairs or upload files. Submit.
208208

209209
<img
210-
src={require("../developer-guide/workflows/ci/images/secret-management.png").default}
211-
alt="Secret Management page in Backstage"
212-
width="100%"
210+
src={
211+
require("../developer-guide/workflows/ci/images/secret-management.png")
212+
.default
213+
}
214+
alt="Secret Management page in Backstage"
215+
width="100%"
213216
/>
214217

215218
The created secret appears in the same list and can be referenced from any component in that namespace by its name.

docs/reference/api/platform/secretreference.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ metadata:
4040

4141
Identifies the plane whose external secret store holds the secret value referenced by this SecretReference. This is the same plane that `occ secret create --target-plane` pushes the value to.
4242

43-
| Field | Type | Required | Default | Description |
44-
| ------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------ |
43+
| Field | Type | Required | Default | Description |
44+
| ------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------- |
4545
| `kind` | string | Yes | - | Plane kind. One of `WorkflowPlane`, `ClusterWorkflowPlane`, `DataPlane`, `ClusterDataPlane` |
46-
| `name` | string | Yes | - | Name of the target plane resource |
46+
| `name` | string | Yes | - | Name of the target plane resource |
4747

4848
### SecretTemplate
4949

0 commit comments

Comments
 (0)