diff --git a/docs/developers/00-overview.mdx b/docs/developers/00-overview.mdx index f907e9f..595016a 100644 --- a/docs/developers/00-overview.mdx +++ b/docs/developers/00-overview.mdx @@ -14,7 +14,7 @@ Whether you're a beginner or an experienced developer, this guide will help you ## Getting Started -Check our guide on [how to create a Service Provider](./serviceprovider/develop) to turn the next Kubernetes-native application into an as-a-Service offering. +Check our guide on [how to create a Service Provider](./serviceprovider/02-develop.mdx) to turn the next Kubernetes-native application into an as-a-Service offering. ## Join the Community diff --git a/docs/developers/serviceprovider/02-develop.mdx b/docs/developers/serviceprovider/02-develop.mdx index 66253df..8bc97aa 100644 --- a/docs/developers/serviceprovider/02-develop.mdx +++ b/docs/developers/serviceprovider/02-develop.mdx @@ -84,7 +84,7 @@ go run ./cmd/template -v -w -module github.com/openmcp-project/service-provider- ``` ::: -For a detailed guide to the [openmcp-testing](https://github.com/openmcp-project/openmcp-testing) testing framework, test structure, and examples, see the [Testing guide](./testing). For running your controller locally outside the cluster and troubleshooting common issues, see the [Debug guide](./debugging). +For a detailed guide to the [openmcp-testing](https://github.com/openmcp-project/openmcp-testing) testing framework, test structure, and examples, see the [Testing guide](./04-testing.mdx). For running your controller locally outside the cluster and troubleshooting common issues, see the [Debug guide](./03-debugging.mdx). The template generator removes its own code after execution. If you want to revert your changes and start fresh, simply use git and delete any generated untracked files. For this reason, remove template-generation step from the e2e test `.github/workflows/go.yaml` before committing your changes (otherwise your workflow will fail). diff --git a/docs/operators/00-overview.md b/docs/operators/00-overview.md index a72c98a..9232cb8 100644 --- a/docs/operators/00-overview.md +++ b/docs/operators/00-overview.md @@ -10,7 +10,7 @@ As a platform operator, you deploy and manage OpenControlPlane so your teams can ## Your Journey **Trying it out locally?** -The [Quickstart](./quickstart) gets you a full local platform in under 10 minutes using `ocpctl`. No infrastructure required. +The [Quickstart](./01-quickstart.md) gets you a full local platform in under 10 minutes using `ocpctl`. No infrastructure required. **Deploying to production?** The [Production Setup](./production-setup/00-overview.md) section covers deploying on real infrastructure with Gardener. diff --git a/docs/operators/production-setup/00-overview.md b/docs/operators/production-setup/00-overview.md index c597cba..9f1da16 100644 --- a/docs/operators/production-setup/00-overview.md +++ b/docs/operators/production-setup/00-overview.md @@ -66,7 +66,7 @@ docker pull ghcr.io/openmcp-project/images/openmcp-bootstrapper:${OPENMCP_BOOTST ## Next Steps -- [Gardener Provider](./gardener-provider) — Deploy on Gardener-managed infrastructure +- [Gardener Provider](./01-gardener-provider.md) — Deploy on Gardener-managed infrastructure ## Coming Soon diff --git a/docs/users/00-getting-started.md b/docs/users/00-getting-started.md index b06e02e..5c640aa 100644 --- a/docs/users/00-getting-started.md +++ b/docs/users/00-getting-started.md @@ -18,20 +18,20 @@ This guide will help you understand and use OpenControlPlane effectively: ### Getting Started Learn the basics of working with OpenControlPlane: -- **[Onboarding](./getting-started/onboard)** - Create your first project and workspace -- **[Connect](./getting-started/connect)** - Access your control plane -- **[Configure](./getting-started/configure)** - Set up services and resources +- **[Onboarding](./getting-started/01-onboard.md)** - Create your first project and workspace +- **[Connect](./getting-started/02-connect.md)** - Access your control plane +- **[Configure](./getting-started/03-configure.md)** - Set up services and resources ### Core Concepts Understand the building blocks: -- **[Managed Control Plane](./concepts/managed-control-plane)** - Your dedicated Kubernetes API server -- **[Projects & Workspaces](./concepts/managed-control-plane)** - Organize teams and environments -- **[Service Providers](./concepts/service-provider)** - Deploy services like Crossplane or Landscaper +- **[Managed Control Plane](./concepts/managed-control-plane.md)** - Your dedicated Kubernetes API server +- **[Projects & Workspaces](./concepts/managed-control-plane.md)** - Organize teams and environments +- **[Service Providers](./concepts/service-provider.md)** - Deploy services like Crossplane or Landscaper ### Ecosystem -Explore the [open-source projects](./ecosystem) that power OpenControlPlane, including Kubernetes, Crossplane, Gardener, and Landscaper. +Explore the [open-source projects](./ecosystem.md) that power OpenControlPlane, including Kubernetes, Crossplane, Gardener, and Landscaper. ## Quick Navigation @@ -65,4 +65,4 @@ Explore the [open-source projects](./ecosystem) that power OpenControlPlane, inc --- -Ready to get started? Head to the [onboarding guide](./getting-started/onboard) to create your first control plane. +Ready to get started? Head to the [onboarding guide](./getting-started/01-onboard.md) to create your first control plane.