Skip to content

Commit 4cae993

Browse files
committed
Update doc links to use relative path
1 parent 7160bc9 commit 4cae993

25 files changed

+115
-114
lines changed

docs/getting-started/deploy-first-component.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@ This guide walks you through deploying your first component on OpenChoreo. By th
1010

1111
Before you begin, ensure you have:
1212

13-
-**OpenChoreo installed** in your Kubernetes cluster ([Single Cluster Setup](/docs/getting-started/single-cluster/))
13+
-**OpenChoreo installed** in your Kubernetes cluster ([Single Cluster Setup](./single-cluster.md))
1414
-**kubectl** configured to access your cluster
1515
-**OpenChoreo context** set to your cluster (should be `kind-openchoreo` if following the setup guide)
1616

1717
## Step 1: Verify Your Setup
1818

19-
First, make sure you have setup choreo on your local cluster following the [guide](/docs/getting-started/single-cluster)
19+
First, make sure you have setup choreo on your local cluster following the [guide](./single-cluster.md)
2020

2121
You should see all OpenChoreo components running with the control plane and data plane pods in `Running` status.
2222

docs/getting-started/single-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ kubectl get nodes
377377
After completing this setup you can:
378378

379379
1. **Explore the Backstage portal** (if instal- Direct links to source code and documentationled) at `http://localhost:7007` to get familiar with the developer interface
380-
2. [Deploy your first component](/docs/getting-started/deploy-first-component) and see it appear automatically in Backstage
380+
2. [Deploy your first component](./deploy-first-component.md) and see it appear automatically in Backstage
381381
3. Test the [GCP microservices demo](https://github.com/openchoreo/openchoreo/tree/main/samples/gcp-microservices-demo) to see multi-component applications in action
382382
4. Deploy additional sample applications from the [OpenChoreo samples](https://github.com/openchoreo/openchoreo/tree/main/samples)
383383
5. Use Backstage to monitor component health, view logs, and manage your application portfolio

docs/learn-from-examples/examples-catalog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ OpenChoreo provides abstractions to define:
2828
- **BuildPlanes** – Define dedicated Kubernetes clusters for CI/CD operations.
2929
- **DeploymentPipelines** – Automate application rollouts with promotion workflows.
3030

31-
For more details on these concepts, refer to the [Concepts](/docs/concepts/platform-abstractions) documentation.
31+
For more details on these concepts, refer to the [Concepts](../concepts/platform-abstractions.md) documentation.
3232

3333
These default configurations provide a quick starting point. Once you have done some exploration you can start creating the necessary artifacts to match the needs of your organization. You can:
3434

docs/overview/architecture.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,8 @@ Organizations typically map environments to Data Planes:
327327

328328
## Next Steps
329329

330-
- **[Concepts](/docs/concepts/developer-abstractions/)** - Learn about Projects, Components, and other abstractions
331-
- **[Quick Start Guide](/docs/getting-started/quick-start-guide/)** - Try OpenChoreo with a single-cluster development setup
332-
- **[Installation Guide](/docs/getting-started/single-cluster/)** - Deploy OpenChoreo in your environment
333-
- **[API Reference](/docs/reference/api/application/project/)** - Detailed documentation of all custom resources
330+
- **[Concepts](../concepts/developer-abstractions.md)** - Learn about Projects, Components, and other abstractions
331+
- **[Quick Start Guide](../getting-started/quick-start-guide.md)** - Try OpenChoreo with a single-cluster development
332+
setup
333+
- **[Installation Guide](../getting-started/single-cluster.md)** - Deploy OpenChoreo in your environment
334+
- **[API Reference](../reference/api/application/project.md)** - Detailed documentation of all custom resources

docs/overview/what-is-openchoreo.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -82,10 +82,10 @@ See our [Roadmap](https://github.com/orgs/openchoreo/projects/4) for upcoming fe
8282

8383
Ready to try OpenChoreo? Start here:
8484

85-
1. **[Architecture](/docs/overview/architecture)** - Understand the multi-plane architecture
86-
2. **[Quick Start Guide](/docs/getting-started/quick-start-guide)** - Try OpenChoreo in minutes using a Dev Container
87-
3. **[Installation Guide](/docs/getting-started/single-cluster)** - Deploy OpenChoreo in your environment
88-
4. **[Concepts](/docs/concepts/developer-abstractions)** - Learn the platform abstractions
85+
1. **[Architecture](./architecture.md)** - Understand the multi-plane architecture
86+
2. **[Quick Start Guide](../getting-started/quick-start-guide.md)** - Try OpenChoreo in minutes using a Dev Container
87+
3. **[Installation Guide](../getting-started/single-cluster.md)** - Deploy OpenChoreo in your environment
88+
4. **[Concepts](../concepts/developer-abstractions.md)** - Learn the platform abstractions
8989

9090
## Community
9191

docs/reference/api/application/build.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,6 +154,6 @@ Builds support the following annotations:
154154

155155
## Related Resources
156156

157-
- [Component](/docs/reference/api/application/component/) - Components that trigger builds
158-
- [Workload](/docs/reference/api/application/workload/) - Workloads created by successful builds
159-
- [BuildPlane](/docs/reference/api/platform/buildplane/) - Infrastructure where builds execute
157+
- [Component](./component.md) - Components that trigger builds
158+
- [Workload](./workload.md) - Workloads created by successful builds
159+
- [BuildPlane](../platform/buildplane.md) - Infrastructure where builds execute

docs/reference/api/application/component.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,9 @@ Components support the following annotations:
164164

165165
## Related Resources
166166

167-
- [Project](/docs/reference/api/application/project/) - Contains components
168-
- [Build](/docs/reference/api/application/build/) - Build jobs triggered by components
169-
- [Workload](/docs/reference/api/application/workload/) - Workload definitions associated with components
170-
- [Service](/docs/reference/api/application/service/) - Service-type component resources
171-
- [WebApplication](/docs/reference/api/application/webapplication/) - WebApplication-type component resources
172-
- [ScheduledTask](/docs/reference/api/application/scheduledtask/) - ScheduledTask-type component resources
167+
- [Project](./project.md) - Contains components
168+
- [Build](./build.md) - Build jobs triggered by components
169+
- [Workload](./workload.md) - Workload definitions associated with components
170+
- [Service](./service.md) - Service-type component resources
171+
- [WebApplication](./webapplication.md) - WebApplication-type component resources
172+
- [ScheduledTask](./scheduledtask.md) - ScheduledTask-type component resources

docs/reference/api/application/project.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,6 @@ Projects support the following annotations:
7777

7878
## Related Resources
7979

80-
- [Component](/docs/reference/api/application/component/) - Deployable units within projects
81-
- [DeploymentPipeline](/docs/reference/api/platform/deployment-pipeline/) - Defines environment promotion paths
82-
- [Organization](/docs/reference/api/platform/organization/) - Contains projects
80+
- [Component](./component.md) - Deployable units within projects
81+
- [DeploymentPipeline](../platform/deployment-pipeline.md) - Defines environment promotion paths
82+
- [Organization](../platform/organization.md) - Contains projects

docs/reference/api/application/scheduledtask.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ ScheduledTasks support the following annotations:
8787

8888
## Related Resources
8989

90-
- [Component](/docs/reference/api/application/component/) - Components that own scheduled tasks
91-
- [Workload](/docs/reference/api/application/workload/) - Workloads referenced by scheduled tasks
92-
- [ScheduledTaskClass](/docs/reference/api/platform/scheduledtaskclass/) - Platform-defined scheduled task templates
93-
- [ScheduledTaskBinding](/docs/reference/api/runtime/scheduledtaskbinding/) - Environment-specific scheduled task instances
90+
- [Component](./component.md) - Components that own scheduled tasks
91+
- [Workload](./workload.md) - Workloads referenced by scheduled tasks
92+
- [ScheduledTaskClass](../platform/scheduledtaskclass.md) - Platform-defined scheduled task templates
93+
- [ScheduledTaskBinding](../runtime/scheduledtaskbinding.md) - Environment-specific scheduled task instances

docs/reference/api/application/service.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ Services support the following annotations:
141141

142142
## Related Resources
143143

144-
- [Component](/docs/reference/api/application/component/) - Components that own services
145-
- [Workload](/docs/reference/api/application/workload/) - Workloads referenced by services
146-
- [ServiceClass](/docs/reference/api/platform/serviceclass/) - Platform-defined service templates
147-
- [ServiceBinding](/docs/reference/api/runtime/servicebinding/) - Environment-specific service instances
144+
- [Component](./component.md) - Components that own services
145+
- [Workload](./workload.md) - Workloads referenced by services
146+
- [ServiceClass](../platform/serviceclass.md) - Platform-defined service templates
147+
- [ServiceBinding](../runtime/servicebinding.md) - Environment-specific service instances

0 commit comments

Comments
 (0)