diff --git a/docs/_constants.mdx b/docs/_constants.mdx new file mode 100644 index 0000000..33b9e6f --- /dev/null +++ b/docs/_constants.mdx @@ -0,0 +1,8 @@ +[//] # (This file stores the constants used across the documentation.) + +export const versions = { + dockerTag: 'v0.3.0', + // TODO: Update this to the latest release version after v0.3.1 is released. + githubRef: 'release-v0.3', // Used for the GitHub Raw URL references. Example: main, latest, v0.1.0 + helmChart: '0.3.0', +}; diff --git a/docs/getting-started/deploy-first-component.md b/docs/getting-started/deploy-first-component.mdx similarity index 86% rename from docs/getting-started/deploy-first-component.md rename to docs/getting-started/deploy-first-component.mdx index e8e3a97..4e7de4f 100644 --- a/docs/getting-started/deploy-first-component.md +++ b/docs/getting-started/deploy-first-component.mdx @@ -2,6 +2,9 @@ title: Deploy Your First Component --- +import CodeBlock from '@theme/CodeBlock'; +import {versions} from '../_constants.mdx'; + # Deploy Your First Component This guide walks you through deploying your first component on OpenChoreo. By the end of this tutorial, you'll have a running web service accessible through the platform, complete with monitoring and security configured automatically. @@ -10,13 +13,13 @@ This guide walks you through deploying your first component on OpenChoreo. By th Before you begin, ensure you have: -- ✅ **OpenChoreo installed** in your Kubernetes cluster ([Single Cluster Setup](./single-cluster.md)) +- ✅ **OpenChoreo installed** in your Kubernetes cluster ([Single Cluster Setup](single-cluster.mdx)) - ✅ **kubectl** configured to access your cluster - ✅ **OpenChoreo context** set to your cluster (should be `kind-openchoreo` if following the setup guide) ## Step 1: Verify Your Setup -First, make sure you have setup choreo on your local cluster following the [guide](./single-cluster.md) +First, make sure you have setup choreo on your local cluster following the [guide](single-cluster.mdx) You should see all OpenChoreo components running with the control plane and data plane pods in `Running` status. @@ -24,10 +27,10 @@ You should see all OpenChoreo components running with the control plane and data For this tutorial, we'll use the Go Greeter Service sample that comes with OpenChoreo. This is a simple web service that demonstrates OpenChoreo's core capabilities. -```bash -# Deploy the greeter service (Component, Workload, Service) -kubectl apply -f https://raw.githubusercontent.com/openchoreo/openchoreo/main/samples/from-image/go-greeter-service/greeter-service.yaml -``` + +{`# Deploy the greeter service (Component, Workload, Service) +kubectl apply -f https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/samples/from-image/go-greeter-service/greeter-service.yaml`} + This single command creates: - **Component**: Defines the application and its requirements @@ -128,10 +131,10 @@ Your application is now running in a production-ready environment with enterpris To remove the sample application: -```bash -# Remove the greeter service -kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/main/samples/from-image/go-greeter-service/greeter-service.yaml + +{`# Remove the greeter service +kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/samples/from-image/go-greeter-service/greeter-service.yaml # Remove the build sample (if deployed) -kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/main/samples/from-source/services/go-google-buildpack-reading-list/reading-list-service.yaml -``` +kubectl delete -f https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/samples/from-source/services/go-google-buildpack-reading-list/reading-list-service.yaml`} + diff --git a/docs/getting-started/quick-start-guide.md b/docs/getting-started/quick-start-guide.mdx similarity index 91% rename from docs/getting-started/quick-start-guide.md rename to docs/getting-started/quick-start-guide.mdx index 56d355f..3dc0798 100644 --- a/docs/getting-started/quick-start-guide.md +++ b/docs/getting-started/quick-start-guide.mdx @@ -2,6 +2,11 @@ title: Quick Start Guide --- + +import CodeBlock from '@theme/CodeBlock'; +import Link from '@docusaurus/Link'; +import {versions} from '../_constants.mdx'; + # Quick Start Guide Setting up OpenChoreo in a Kubernetes cluster involves multiple steps and tools. This guide provides a fast and simple way to install a fully functional OpenChoreo instance on your local machine with minimal prerequisites and effort by using a pre-configured dev container. @@ -20,25 +25,25 @@ To get started, you’ll need: Run the following command to start the dev container and launch a terminal session within it: -```shell -docker run --rm -it --name openchoreo-quick-start \ + + {String.raw`docker run --rm -it --name openchoreo-quick-start \ --pull always \ -v /var/run/docker.sock:/var/run/docker.sock \ --network bridge \ -p 8443:8443 \ -p 7007:7007 \ -ghcr.io/openchoreo/quick-start:latest-dev +ghcr.io/openchoreo/quick-start:`}{versions.dockerTag} + -``` ### Install OpenChoreo This process sets up a [KinD](https://kind.sigs.k8s.io/) (Kubernetes-in-Docker) cluster in your Docker environment and installs OpenChoreo along with its dependencies. To begin the installation, run: -```shell -./install.sh --openchoreo-version 0.0.0-latest-dev -``` + +{`./install.sh --openchoreo-version ${versions.helmChart}`} + **💡 Tip:** If you previously used this setup and encounter errors during installation, ensure you perform the proper cleanup as outlined in the [Cleaning up](#cleaning-up) section before starting again. @@ -90,7 +95,7 @@ Once the installation is complete, you will see the following confirmation messa ``` **📝 Note:** If you see any components are still in the `pending` state, you can check the status again in few minutes. Run the following command to check the installation status of components: -```shell +```bash ./check-status.sh ``` @@ -113,7 +118,7 @@ The portal will automatically discover and display any components you deploy thr You now have OpenChoreo fully setup in your docker environment. Next, lets deploy a sample Web Application by running the following command: -```shell +```bash ./deploy_web_application.sh ``` @@ -147,21 +152,21 @@ To access the artifacts created in OpenChoreo you can use choreoctl as shown in You can check each resource type -```shell +```bash kubectl get organizations ``` -```shell +```bash kubectl get dataplanes ``` -```shell +```bash kubectl get environments ``` -```shell +```bash kubectl get projects ``` To get more details on any of these abstractions, you can use a similar command to the following command: -```shell +```bash kubectl get project default -oyaml ``` @@ -170,11 +175,11 @@ The deploy script creates a sample Web Application Component, along with a Deplo To inspect these resources in more detail, run the following commands: -```shell +```bash kubectl get components ``` -**💡 Tip:** You can try out more samples on this setup. Check out our [Samples](https://github.com/openchoreo/openchoreo/tree/main/samples) for more details. The samples are also available in the dev container at `/samples`. +**💡 Tip:** You can try out more samples on this setup. Check out our Samples for more details. The samples are also available in the dev container at `/samples`. **⚠️ Important:** If you try out samples in the dev container, you don't need to expose the OpenChoreo Gateway to your host machine. The OpenChoreo gateway is already exposed to host machine via dev container port 8443. @@ -182,15 +187,13 @@ kubectl get components After finishing your work, you have two options: 1. **Exit and return later**: If you plan to return, simply exit the dev container by running: - ```shell - exit + ```bash + exit ``` 2. **Full cleanup**: To remove all resources and clean up the environment completely, run: - ```shell - ./uninstall.sh - ``` - ```shell - exit + ```bash + ./uninstall.sh + exit ``` That's it! diff --git a/docs/getting-started/single-cluster.md b/docs/getting-started/single-cluster.mdx similarity index 81% rename from docs/getting-started/single-cluster.md rename to docs/getting-started/single-cluster.mdx index a2d5762..55348e6 100644 --- a/docs/getting-started/single-cluster.md +++ b/docs/getting-started/single-cluster.mdx @@ -3,6 +3,10 @@ title: Single Cluster description: Try OpenChoreo locally with a single Kind cluster setup. --- +import CodeBlock from '@theme/CodeBlock'; +import Link from '@docusaurus/Link'; +import {versions} from '../_constants.mdx'; + # Single Cluster Setup This guide provides step-by-step instructions for setting up a local development environment for OpenChoreo using Kind (Kubernetes in Docker). @@ -47,9 +51,9 @@ This setup uses pre-built images and Helm charts from the OpenChoreo registry. Create a new Kind cluster using the provided configuration: -```bash -curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/main/install/kind/kind-config.yaml | kind create cluster --config=- -``` + +{`curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/kind/kind-config.yaml | kind create cluster --config=-`} + This will: - Create a cluster named "openchoreo" @@ -61,9 +65,9 @@ This will: Install Cilium as the Container Network Interface (CNI). This will create the `cilium` namespace automatically: -```bash -helm install cilium oci://ghcr.io/openchoreo/helm-charts/cilium --create-namespace --namespace cilium --wait -``` + +{`helm install cilium oci://ghcr.io/openchoreo/helm-charts/cilium --version ${versions.helmChart} --create-namespace --namespace cilium --wait`} + Wait for Cilium pods to be ready: @@ -83,11 +87,12 @@ You should see both nodes in `Ready` status. Install the OpenChoreo control plane using the following helm install command. This will create the `openchoreo-control-plane` namespace automatically: -```bash -helm install control-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-control-plane \ - --create-namespace --namespace openchoreo-control-plane \ - --timeout=10m -``` + +{`helm install control-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-control-plane \\ + --version ${versions.helmChart} \\ + --create-namespace --namespace openchoreo-control-plane \\ + --timeout=10m`} + Wait for the installation to complete and verify all pods are running: @@ -104,13 +109,14 @@ You should see pods for: Install the OpenChoreo data plane using the following helm install command. This will create the `openchoreo-data-plane` namespace automatically: -```bash -helm install data-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-data-plane \ - --create-namespace --namespace openchoreo-data-plane \ - --timeout=10m \ - --set cert-manager.enabled=false \ - --set cert-manager.crds.enabled=false -``` + +{`helm install data-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-data-plane \\ + --version ${versions.helmChart} \\ + --create-namespace --namespace openchoreo-data-plane \\ + --timeout=10m \\ + --set cert-manager.enabled=false \\ + --set cert-manager.crds.enabled=false`} + Note: We disable cert-manager since it's already installed by the control plane. @@ -136,10 +142,11 @@ The Build Plane is required if you plan to use OpenChoreo’s internal CI capabi Install the OpenChoreo build plane using the following helm install command for CI/CD capabilities using Argo Workflows. This will create the `openchoreo-build-plane` namespace automatically: -```bash -helm install build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \ - --create-namespace --namespace openchoreo-build-plane --timeout=10m -``` + +{`helm install build-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-build-plane \\ + --version ${versions.helmChart} \\ + --create-namespace --namespace openchoreo-build-plane --timeout=10m`} + Wait for the build plane components to be ready: @@ -154,9 +161,9 @@ You should see pods for: Register the build plane with the control plane by running: -```bash -curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/main/install/add-build-plane.sh | bash -``` + +{`curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/add-build-plane.sh | bash`} + This script will: - Detect single-cluster mode automatically @@ -174,9 +181,9 @@ kubectl get buildplane -n default Register the data plane with the control plane by running: -```bash -curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/main/install/add-default-dataplane.sh | bash -``` + +{`curl -s https://raw.githubusercontent.com/openchoreo/openchoreo/${versions.githubRef}/install/add-default-dataplane.sh | bash`} + This script will: - Detect single-cluster mode automatically @@ -194,11 +201,12 @@ kubectl get dataplane -n default Install the OpenChoreo observability plane using the following helm install command for monitoring and logging capabilities. This will create the `openchoreo-observability-plane` namespace automatically: -```bash -helm install observability-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-observability-plane \ - --create-namespace --namespace openchoreo-observability-plane \ - --timeout=10m -``` + +{`helm install observability-plane oci://ghcr.io/openchoreo/helm-charts/openchoreo-observability-plane \\ + --version ${versions.helmChart} \\ + --create-namespace --namespace openchoreo-observability-plane \\ + --timeout=10m`} + Wait for the observability plane components to be ready: @@ -270,10 +278,11 @@ The Backstage portal provides: - **Logs**: View runtime logs and build logs of each component - **Configure and Deploy**: Configure, deploy and promote web applications and services through environments -```bash -helm install openchoreo-backstage-demo oci://ghcr.io/openchoreo/helm-charts/backstage-demo \ - --namespace openchoreo-control-plane -``` + +{`helm install openchoreo-backstage-demo oci://ghcr.io/openchoreo/helm-charts/backstage-demo \\ + --version ${versions.helmChart} \\ + --namespace openchoreo-control-plane`} + Wait for the Backstage pod to be ready: @@ -377,9 +386,9 @@ kubectl get nodes After completing this setup you can: 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 -2. [Deploy your first component](./deploy-first-component.md) and see it appear automatically in Backstage -3. Test the [GCP microservices demo](https://github.com/openchoreo/openchoreo/tree/main/samples/gcp-microservices-demo) to see multi-component applications in action -4. Deploy additional sample applications from the [OpenChoreo samples](https://github.com/openchoreo/openchoreo/tree/main/samples) +2. [Deploy your first component](./deploy-first-component.mdx) and see it appear automatically in Backstage +3. Test the GCP microservices demo to see multi-component applications in action +4. Deploy additional sample applications from the OpenChoreo samples 5. Use Backstage to monitor component health, view logs, and manage your application portfolio 6. Develop and test new OpenChoreo features diff --git a/docs/learn-from-examples/examples-catalog.md b/docs/learn-from-examples/examples-catalog.mdx similarity index 53% rename from docs/learn-from-examples/examples-catalog.md rename to docs/learn-from-examples/examples-catalog.mdx index 04bc18e..df73356 100644 --- a/docs/learn-from-examples/examples-catalog.md +++ b/docs/learn-from-examples/examples-catalog.mdx @@ -2,6 +2,15 @@ title: Learn from Examples --- +import Link from '@docusaurus/Link'; +import {versions} from '../_constants.mdx'; + +export const GitHubSampleLink = ({path, children}) => ( + + {children} + +); + # Learn from Examples OpenChoreo empowers developers to build cloud-native applications through practical, real-world examples. This section provides comprehensive tutorials that demonstrate OpenChoreo's capabilities across different use cases and complexity levels. @@ -32,8 +41,8 @@ For more details on these concepts, refer to the [Concepts](../concepts/platform 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: -- [Create new environments](https://github.com/openchoreo/openchoreo/tree/main/samples/platform-config/new-environments) in your organization -- [Create a new deployment pipeline](https://github.com/openchoreo/openchoreo/tree/main/samples/platform-config/new-deployment-pipeline) that will link these environments +- Create new environments in your organization +- Create a new deployment pipeline that will link these environments --- @@ -44,28 +53,28 @@ These samples help you deploy different types of applications using OpenChoreo. OpenChoreo supports different component types with the modern **Component** resource: -- **[Services](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services)** – Backend services & APIs built from source code - - [Go Service with Docker](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/go-docker-greeter/) - REST API service with Docker build - - [Go Service with Buildpacks](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/go-google-buildpack-reading-list/) - Service using Cloud Native Buildpacks - - [Ballerina Service](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/ballerina-buildpack-patient-management/) - Ballerina language service +- **Services** – Backend services & APIs built from source code + - Go Service with Docker - REST API service with Docker build + - Go Service with Buildpacks - Service using Cloud Native Buildpacks + - Ballerina Service - Ballerina language service -- **[Web Applications](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/web-apps/)** – Frontend or full-stack applications - - [React SPA](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/web-apps/react-starter/) - Single-page application built from source +- **Web Applications** – Frontend or full-stack applications + - React SPA - Single-page application built from source -- **[Pre-built Applications](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/)** – Applications deployed from existing container images - - [Go Greeter Service](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/go-greeter-service/) - Service deployed from pre-built image - - [React Web App](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/react-starter-web-app/) - Web application from pre-built image - - [GitHub Issue Reporter](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/issue-reporter-schedule-task/) - Scheduled task with configuration management +- **Pre-built Applications** – Applications deployed from existing container images + - Go Greeter Service - Service deployed from pre-built image + - React Web App - Web application from pre-built image + - GitHub Issue Reporter - Scheduled task with configuration management -- **[Managed APIs](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples)** - Exposing services as Managed APIs - - [Securing a Managed API](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/authentication) - Using a JWT token to secure a Managed API - - [Circuit Breaker Pattern](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/circuit-breaker) - Using the Circuit Breaker pattern to avoid cascading failures in Managed APIs - - [Cross-Origin Resource Sharing(CORS)](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/cors) - Illustrates how to allow Cross-origin requests to a Managed API - - [Rate Limiting](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/rate-limiting) - Configuring rate limiting in a Managed API +- **Managed APIs** - Exposing services as Managed APIs + - Securing a Managed API - Using a JWT token to secure a Managed API + - Circuit Breaker Pattern - Using the Circuit Breaker pattern to avoid cascading failures in Managed APIs + - Cross-Origin Resource Sharing(CORS) - Illustrates how to allow Cross-origin requests to a Managed API + - Rate Limiting - Configuring rate limiting in a Managed API ### Complete Application Examples -- **[GCP Microservices Demo](https://github.com/openchoreo/openchoreo/tree/main/samples/gcp-microservices-demo/)** – Complete multi-service application demonstrating: +- **GCP Microservices Demo** – Complete multi-service application demonstrating: - Project organization with multiple components - Service interactions and dependencies - Coordinated deployment patterns @@ -73,20 +82,20 @@ OpenChoreo supports different component types with the modern **Component** reso ### Supported Languages (via BuildPacks) OpenChoreo abstracts the build and deployment process using BuildPacks and Build resources, enabling developers to deploy applications written in: -- **Ballerina** - [Patient Management Service](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/ballerina-buildpack-patient-management/) -- **Go** - [Greeter Service](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/go-docker-greeter/) and [Reading List](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/go-google-buildpack-reading-list/) -- **Node.js/React** - [React Starter](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/web-apps/react-starter/) +- **Ballerina** - Patient Management Service +- **Go** - Greeter Service and Reading List +- **Node.js/React** - React Starter - **Python** - (Additional samples can be added) - **Ruby** - (Additional samples can be added) - (More languages can be added as extensions.) ### Key Features Demonstrated -- **[Build Integration](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/)** – Component with integrated Build for CI/CD workflows -- **[Configuration Management](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/issue-reporter-schedule-task/)** – Environment-specific configuration with ConfigurationGroups -- **[Security Policies](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/authentication)** – JWT authentication and API security -- **[Class/Binding Pattern](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/)** – ServiceClass templates with environment-specific ServiceBindings -- **[API Management](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/)** - Managed APIs with security and rate limiting +- **Build Integration** – Component with integrated Build for CI/CD workflows +- **Configuration Management** – Environment-specific configuration with ConfigurationGroups +- **Security Policies** – JWT authentication and API security +- **Class/Binding Pattern** – ServiceClass templates with environment-specific ServiceBindings +- **API Management** - Managed APIs with security and rate limiting ### Getting Started @@ -122,7 +131,7 @@ Learn OpenChoreo fundamentals by deploying a simple Go REST service built from s - REST API with greeting endpoints - Gateway integration and testing -**Try it:** [Go Docker Greeter](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/go-docker-greeter) +**Try it:** Go Docker Greeter ### Secure Reading List Service with JWT Deploy a production-ready service with JWT authentication using OpenChoreo's API management capabilities. This example shows how to secure your APIs and manage authentication. @@ -133,7 +142,7 @@ Deploy a production-ready service with JWT authentication using OpenChoreo's API - OAuth2 client credentials flow - Authenticated and unauthenticated access testing -**Try it:** [Secure Service with JWT](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/authentication) +**Try it:** Secure Service with JWT ### Google Cloud Microservices Demo Build a complete e-commerce platform using Google's reference microservices architecture. This comprehensive example demonstrates service-to-service communication, distributed systems patterns, and complex application deployment. @@ -145,7 +154,7 @@ Build a complete e-commerce platform using Google's reference microservices arch - Production-ready container images - Service mesh communication patterns -**Try it:** [GCP Microservices Demo](https://github.com/openchoreo/openchoreo/tree/main/samples/gcp-microservices-demo) +**Try it:** GCP Microservices Demo ### Multi-Environment Deployment Pipeline Set up sophisticated deployment pipelines across development, QA, pre-production, and production environments with automated promotion workflows. @@ -156,7 +165,7 @@ Set up sophisticated deployment pipelines across development, QA, pre-production - Automated rollout workflows - Production-ready governance -**Try it:** [New Deployment Pipeline](https://github.com/openchoreo/openchoreo/tree/main/samples/platform-config/new-deployment-pipeline) +**Try it:** New Deployment Pipeline --- diff --git a/docs/overview/architecture.md b/docs/overview/architecture.md index e22c08f..e1788e4 100644 --- a/docs/overview/architecture.md +++ b/docs/overview/architecture.md @@ -328,7 +328,7 @@ Organizations typically map environments to Data Planes: ## Next Steps - **[Concepts](../concepts/developer-abstractions.md)** - Learn about Projects, Components, and other abstractions -- **[Quick Start Guide](../getting-started/quick-start-guide.md)** - Try OpenChoreo with a single-cluster development +- **[Quick Start Guide](../getting-started/quick-start-guide.mdx)** - Try OpenChoreo with a single-cluster development setup -- **[Installation Guide](../getting-started/single-cluster.md)** - Deploy OpenChoreo in your environment +- **[Installation Guide](../getting-started/single-cluster.mdx)** - Deploy OpenChoreo in your environment - **[API Reference](../reference/api/application/project.md)** - Detailed documentation of all custom resources diff --git a/docs/overview/what-is-openchoreo.md b/docs/overview/what-is-openchoreo.mdx similarity index 91% rename from docs/overview/what-is-openchoreo.md rename to docs/overview/what-is-openchoreo.mdx index 179a924..3869dea 100644 --- a/docs/overview/what-is-openchoreo.md +++ b/docs/overview/what-is-openchoreo.mdx @@ -3,6 +3,9 @@ title: What is OpenChoreo slug: / --- +import Link from '@docusaurus/Link'; +import {versions} from '../_constants.mdx'; + # What is OpenChoreo? OpenChoreo is an open-source Internal Developer Platform (IDP) that makes Kubernetes accessible to development teams. It @@ -83,8 +86,8 @@ See our [Roadmap](https://github.com/orgs/openchoreo/projects/4) for upcoming fe Ready to try OpenChoreo? Start here: 1. **[Architecture](./architecture.md)** - Understand the multi-plane architecture -2. **[Quick Start Guide](../getting-started/quick-start-guide.md)** - Try OpenChoreo in minutes using a Dev Container -3. **[Installation Guide](../getting-started/single-cluster.md)** - Deploy OpenChoreo in your environment +2. **[Quick Start Guide](../getting-started/quick-start-guide.mdx)** - Try OpenChoreo in minutes using a Dev Container +3. **[Installation Guide](../getting-started/single-cluster.mdx)** - Deploy OpenChoreo in your environment 4. **[Concepts](../concepts/developer-abstractions.md)** - Learn the platform abstractions ## Community @@ -93,5 +96,5 @@ OpenChoreo is an open-source project that welcomes contributions. Join our commu - [GitHub Discussions](https://github.com/openchoreo/openchoreo/discussions) for questions and ideas - [Discord](https://discord.com/invite/asqDFC8suT) for real-time chat -- [Contributing Guide](https://github.com/openchoreo/openchoreo/blob/main/docs/contributors/contribute.md) to get +- Contributing Guide to get involved diff --git a/docs/reference/faq.md b/docs/reference/faq.md index 12da6a5..4d78a9d 100644 --- a/docs/reference/faq.md +++ b/docs/reference/faq.md @@ -33,13 +33,13 @@ OpenChoreo focuses on: - **Container Registry**: For storing application images ### How do I install OpenChoreo? -Refer to [Install guidelines](../getting-started/single-cluster.md) +Refer to [Install guidelines](../getting-started/single-cluster.mdx) ### Can I try OpenChoreo locally? -Yes! Use k3d or kind or rancher desktop to create a local kubernetes environment and then follow the [installation guide](../getting-started/single-cluster.md) +Yes! Use k3d or kind or rancher desktop to create a local kubernetes environment and then follow the [installation guide](../getting-started/single-cluster.mdx) ### What's the simplest way to deploy my first application? -Follow [Deploying your first component](../getting-started/deploy-first-component.md) +Follow [Deploying your first component](../getting-started/deploy-first-component.mdx) --- @@ -100,7 +100,7 @@ OpenChoreo is licensed under the **Apache 2.0 License**, ensuring: - **Enterprise-friendly terms** ### Where can I get help? -- **Documentation**: Comprehensive guides at [openchoreo.dev](../overview/what-is-openchoreo.md) +- **Documentation**: Comprehensive guides at [openchoreo.dev](../overview/what-is-openchoreo.mdx) - **Community Forum**: GitHub Discussions for questions - **Chat**: Real-time help on Discord - **Issues**: Bug reports on GitHub Issues @@ -118,6 +118,6 @@ Not yet **Can't find your question?** -- Search our [documentation](../overview/what-is-openchoreo.md) +- Search our [documentation](../overview/what-is-openchoreo.mdx) - Ask in [GitHub Discussions](https://github.com/openchoreo/openchoreo/discussions) - Join our [Discord channel](https://discord.com/invite/asqDFC8suT)