Skip to content

Commit a248772

Browse files
committed
Fixes sample links
1 parent cdee8eb commit a248772

File tree

1 file changed

+32
-26
lines changed

1 file changed

+32
-26
lines changed

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

Lines changed: 32 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -33,58 +33,64 @@ For more details on these concepts, refer to the [OpenChoreo Concepts and Abstra
3333

3434
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:
3535

36-
- [Create new environments](https://github.com/openchoreo/openchoreo/tree/new-crds/new-design-sample/platform-config/new-environments) in your organization
37-
- [Create a new deployment pipeline](https://github.com/openchoreo/openchoreo/tree/new-crds/new-design-sample/platform-config/new-deployment-pipeline) that will link these environments
36+
- [Create new environments](https://github.com/openchoreo/openchoreo/tree/main/samples/platform-config/new-environments) in your organization
37+
- [Create a new deployment pipeline](https://github.com/openchoreo/openchoreo/tree/main/samples/platform-config/new-deployment-pipeline) that will link these environments
3838

3939
---
4040

4141
## Application Deployment
4242
These samples help you deploy different types of applications using OpenChoreo. All samples refer to the default setup.
4343

4444
> [!TIP]
45-
> To access the deployed applications, you need to expose the OpenChoreo Gateway to your host machine. Follow the instructions in the [Installation Guide](../docs/install-guide.md#exposing-the-openchoreo-gateway) section to learn more.
45+
> To access the deployed applications, you need to expose the OpenChoreo Gateway to your host machine. Follow the instructions in the [Setup Guide](https://github.com/openchoreo/openchoreo/blob/main/docs/install-guide.md#expose-the-openchoreo-gateway) section to learn more.
4646
4747
### Component Types
4848

4949
OpenChoreo supports different component types with the modern **Component** resource:
5050

51-
- **[Services](./from-source/services/)** – Backend services & APIs built from source code
52-
- [Go Service with Docker](./from-source/services/go-docker-greeter/) - REST API service with Docker build
53-
- [Go Service with Buildpacks](./from-source/services/go-google-buildpack-reading-list/) - Service using Cloud Native Buildpacks
54-
- [Ballerina Service](./from-source/services/ballerina-buildpack-patient-management/) - Ballerina language service
51+
- **[Services](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services)** – Backend services & APIs built from source code
52+
- [Go Service with Docker](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/go-docker-greeter/) - REST API service with Docker build
53+
- [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
54+
- [Ballerina Service](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/ballerina-buildpack-patient-management/) - Ballerina language service
5555

56-
- **[Web Applications](./from-source/web-apps/)** – Frontend or full-stack applications
57-
- [React SPA](./from-source/web-apps/react-starter/) - Single-page application built from source
56+
- **[Web Applications](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/web-apps/)** – Frontend or full-stack applications
57+
- [React SPA](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/web-apps/react-starter/) - Single-page application built from source
5858

59-
- **[Pre-built Applications](./from-image/)** – Applications deployed from existing container images
60-
- [Go Greeter Service](./from-image/go-greeter-service/) - Service deployed from pre-built image
61-
- [React Web App](./from-image/react-starter-web-app/) - Web application from pre-built image
62-
- [GitHub Issue Reporter](./from-image/issue-reporter-schedule-task/) - Scheduled task with configuration management
63-
- [JWT-Secured Service](./from-image/secure-service-with-jwt/) - Service with JWT authentication
59+
- **[Pre-built Applications](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/)** – Applications deployed from existing container images
60+
- [Go Greeter Service](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/go-greeter-service/) - Service deployed from pre-built image
61+
- [React Web App](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/react-starter-web-app/) - Web application from pre-built image
62+
- [GitHub Issue Reporter](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/issue-reporter-schedule-task/) - Scheduled task with configuration management
63+
64+
- **[Managed APIs](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples)** - Exposing services as Managed APIs
65+
- [Securing a Managed API](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/authentication) - Using a JWT token to secure a Managed API
66+
- [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
67+
- [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
68+
- [Rate Limiting](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/rate-limiting) - Configuring rate limiting in a Managed API
6469

6570
### Complete Application Examples
6671

67-
- **[GCP Microservices Demo](./gcp-microservices-demo/)** – Complete multi-service application demonstrating:
72+
- **[GCP Microservices Demo](https://github.com/openchoreo/openchoreo/tree/main/samples/gcp-microservices-demo/)** – Complete multi-service application demonstrating:
6873
- Project organization with multiple components
6974
- Service interactions and dependencies
7075
- Coordinated deployment patterns
7176
- Configuration management across services
7277

7378
### Supported Languages (via BuildPacks)
7479
OpenChoreo abstracts the build and deployment process using BuildPacks and Build resources, enabling developers to deploy applications written in:
75-
- **Ballerina** - [Patient Management Service](./from-source/services/ballerina-buildpack-patient-management/)
76-
- **Go** - [Greeter Service](./from-source/services/go-docker-greeter/) and [Reading List](./from-source/services/go-google-buildpack-reading-list/)
77-
- **Node.js/React** - [React Starter](./from-source/web-apps/react-starter/)
80+
- **Ballerina** - [Patient Management Service](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/ballerina-buildpack-patient-management/)
81+
- **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/)
82+
- **Node.js/React** - [React Starter](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/web-apps/react-starter/)
7883
- **Python** - (Additional samples can be added)
7984
- **Ruby** - (Additional samples can be added)
8085
- (More languages can be added as extensions.)
8186

8287
### Key Features Demonstrated
8388

84-
- **[Build Integration](./from-source/)** – Component with integrated Build for CI/CD workflows
85-
- **[Configuration Management](./from-image/issue-reporter-schedule-task/)** – Environment-specific configuration with ConfigurationGroups
86-
- **[Security Policies](./from-image/secure-service-with-jwt/)** – JWT authentication and API security
87-
- **[Class/Binding Pattern](./from-source/services/)** – ServiceClass templates with environment-specific ServiceBindings
89+
- **[Build Integration](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/)** – Component with integrated Build for CI/CD workflows
90+
- **[Configuration Management](https://github.com/openchoreo/openchoreo/tree/main/samples/from-image/issue-reporter-schedule-task/)** – Environment-specific configuration with ConfigurationGroups
91+
- **[Security Policies](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/authentication)** – JWT authentication and API security
92+
- **[Class/Binding Pattern](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/)** – ServiceClass templates with environment-specific ServiceBindings
93+
- **[API Management](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/)** - Managed APIs with security and rate limiting
8894

8995
### Getting Started
9096

@@ -120,7 +126,7 @@ Learn OpenChoreo fundamentals by deploying a simple Go REST service built from s
120126
- REST API with greeting endpoints
121127
- Gateway integration and testing
122128

123-
**Try it:** [Go Docker Greeter](https://github.com/openchoreo/openchoreo/tree/new-crds/new-design-sample/from-source/services/go-docker-greeter)
129+
**Try it:** [Go Docker Greeter](https://github.com/openchoreo/openchoreo/tree/main/samples/from-source/services/go-docker-greeter)
124130

125131
### Secure Reading List Service with JWT
126132
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.
@@ -131,7 +137,7 @@ Deploy a production-ready service with JWT authentication using OpenChoreo's API
131137
- OAuth2 client credentials flow
132138
- Authenticated and unauthenticated access testing
133139

134-
**Try it:** [Secure Service with JWT](https://github.com/openchoreo/openchoreo/tree/new-crds/new-design-sample/from-image/secure-service-with-jwt)
140+
**Try it:** [Secure Service with JWT](https://github.com/openchoreo/openchoreo/tree/main/samples/apim-samples/authentication)
135141

136142
### Google Cloud Microservices Demo
137143
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.
@@ -143,7 +149,7 @@ Build a complete e-commerce platform using Google's reference microservices arch
143149
- Production-ready container images
144150
- Service mesh communication patterns
145151

146-
**Try it:** [GCP Microservices Demo](https://github.com/openchoreo/openchoreo/tree/new-crds/new-design-sample/gcp-microservices-demo)
152+
**Try it:** [GCP Microservices Demo](https://github.com/openchoreo/openchoreo/tree/main/samples/gcp-microservices-demo)
147153

148154
### Multi-Environment Deployment Pipeline
149155
Set up sophisticated deployment pipelines across development, QA, pre-production, and production environments with automated promotion workflows.
@@ -154,7 +160,7 @@ Set up sophisticated deployment pipelines across development, QA, pre-production
154160
- Automated rollout workflows
155161
- Production-ready governance
156162

157-
**Try it:** [New Deployment Pipeline](https://github.com/openchoreo/openchoreo/tree/new-crds/new-design-sample/platform-config/new-deployment-pipeline)
163+
**Try it:** [New Deployment Pipeline](https://github.com/openchoreo/openchoreo/tree/main/samples/platform-config/new-deployment-pipeline)
158164

159165
---
160166

0 commit comments

Comments
 (0)