Skip to content

Commit 1927dd2

Browse files
Move ci docs to user guides
1 parent 86c7895 commit 1927dd2

File tree

10 files changed

+24
-25
lines changed

10 files changed

+24
-25
lines changed

docs/getting-started/try-it-out/on-managed-kubernetes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ This guide provides a quick way to explore OpenChoreo. For production deployment
596596

597597
3. **Infrastructure**: Scale out and isolate your planes.
598598
- [Multi-Cluster Connectivity](../../operations/multi-cluster-connectivity.mdx) (Isolate Control Plane from Data Planes)
599-
- [Container Registry](../../operations/container-registry.mdx) (Switch to ECR/GCR/ACR)
599+
- [External Container Registry](../../user-guide/ci/external-container-registry.mdx) (Switch to ECR/GCR/ACR)
600600
- [Observability](../../operations/observability-alerting.mdx) (Configure persistent OpenSearch and retention)
601601

602602
## Next Steps
File renamed without changes.
File renamed without changes.

docs/use-cases/external-container-registry.mdx renamed to docs/user-guide/ci/external-container-registry.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
2-
title: Configure External Container Registry
2+
title: External Container Registry
33
description: Learn how to configure OpenChoreo to use external container registries like Docker Hub, AWS ECR, GCR, or ACR for storing and pulling container images in both build and data planes.
4-
sidebar_position: 3
4+
sidebar_position: 7
55
---
66

77
# Configure External Container Registry
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ A **ComponentWorkflowRun** represents a single execution instance of a Component
3737
ComponentWorkflowRuns are created either manually or automatically (e.g., via Git webhooks).
3838

3939
:::warning Imperative Resource
40-
ComponentWorkflowRun is an **imperative** resourceit triggers an action (a build) rather than declaring a desired state. Each time a ComponentWorkflowRun is applied, it initiates a new build execution. For this reason, do not include ComponentWorkflowRuns in GitOps repositories. Instead, create them through Git webhooks, the UI, or direct `kubectl apply` commands.
40+
ComponentWorkflowRun is an **imperative** resource, it triggers an action (a build) rather than declaring a desired state. Each time a ComponentWorkflowRun is applied, it initiates a new build execution. For this reason, do not include ComponentWorkflowRuns in GitOps repositories. Instead, create them through Git webhooks, the UI, or direct `kubectl apply` commands.
4141
:::
4242

4343
## Architecture

docs/use-cases/private-repository-multiple.md renamed to docs/user-guide/ci/private-repository-multiple.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Multiple Private Git Organizations
33
description: Configure workflows to authenticate with private repositories across multiple Git organizations, groups, or workspaces
4-
sidebar_position: 2
4+
sidebar_position: 6
55
---
66

77
# Configure Multiple Private Git Organizations
@@ -211,5 +211,5 @@ spec:
211211
## See Also
212212

213213
- [Private Repositories](./private-repository.mdx) - Basic private repository setup
214-
- [Additional Resources](../operations/ci/additional-resources.md) - Working with ExternalSecrets and other resources
215-
- [Component Workflow Schema](../operations/ci/component-workflow-schema.md) - Parameter system documentation
214+
- [Additional Resources](./additional-resources.md) - Working with ExternalSecrets and other resources
215+
- [Component Workflow Schema](./component-workflow-schema.md) - Parameter system documentation
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Private Git Repository
33
description: Learn how to build applications from private Git repositories using ComponentWorkflows
4-
sidebar_position: 1
4+
sidebar_position: 5
55
---
66

77
# Configure a Private Git Repository
@@ -33,7 +33,7 @@ kubectl patch clustersecretstore default --type='json' -p='[
3333
"path": "/spec/provider/fake/data/-",
3434
"value": {
3535
"key": "git-token",
36-
"value": "YourGitAccessToken"
36+
"value": "GitAccessToken"
3737
}
3838
}
3939
]'
@@ -133,6 +133,6 @@ The ComponentWorkflowRun controller creates this ExternalSecret in the Build Pla
133133

134134
## See Also
135135

136-
- [CI Overview](../operations/ci/overview.md) - Understand ComponentWorkflows and build architecture
137-
- [Custom Workflows](../operations/ci/custom-workflows.md) - Create custom ComponentWorkflows
136+
- [CI Overview](./overview.md) - Understand ComponentWorkflows and build architecture
137+
- [Custom Workflows](./custom-workflows.md) - Create custom ComponentWorkflows
138138
- [External Secrets Operator](https://external-secrets.io/) - Secret management documentation

sidebars.ts

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -52,23 +52,11 @@ const sidebars: SidebarsConfig = {
5252
'operations/backstage-configuration',
5353
'operations/api-management',
5454
'operations/auto-build',
55-
'operations/container-registry',
5655
'operations/secret-management',
57-
'operations/component-workflow-secrets',
5856
'operations/cluster-agent-rbac',
5957
'operations/observability-alerting',
6058
'operations/rca-agent',
6159
'operations/upgrades',
62-
{
63-
type: 'category',
64-
label: 'CI',
65-
items: [
66-
'operations/ci/overview',
67-
'operations/ci/component-workflow-schema',
68-
'operations/ci/custom-workflows',
69-
'operations/ci/additional-resources',
70-
],
71-
},
7260
{
7361
type: 'category',
7462
label: 'GitOps',
@@ -91,8 +79,6 @@ const sidebars: SidebarsConfig = {
9179
items: [
9280
'use-cases/deploy-prebuilt-image',
9381
'use-cases/api-management',
94-
'use-cases/private-repository',
95-
'use-cases/private-repository-multiple',
9682
]
9783
},
9884
{
@@ -114,6 +100,19 @@ const sidebars: SidebarsConfig = {
114100
type: 'category',
115101
label: 'User Guide',
116102
items: [
103+
{
104+
type: 'category',
105+
label: 'CI',
106+
items: [
107+
'user-guide/ci/overview',
108+
'user-guide/ci/component-workflow-schema',
109+
'user-guide/ci/custom-workflows',
110+
'user-guide/ci/additional-resources',
111+
'user-guide/ci/private-repository',
112+
'user-guide/ci/private-repository-multiple',
113+
'user-guide/ci/external-container-registry',
114+
],
115+
},
117116
{
118117
type: 'category',
119118
label: 'Component Types',

0 commit comments

Comments
 (0)