Skip to content

Update documentation for v0.4.0 release#119

Merged
Mirage20 merged 6 commits into
openchoreo:mainfrom
Mirage20:release-v0.4.0
Nov 16, 2025
Merged

Update documentation for v0.4.0 release#119
Mirage20 merged 6 commits into
openchoreo:mainfrom
Mirage20:release-v0.4.0

Conversation

@Mirage20

@Mirage20 Mirage20 commented Nov 16, 2025

Copy link
Copy Markdown
Contributor

Purpose

Update all getting started guides and API reference documentation for the v0.4.0 release. This includes migrating from Kind to k3d, introducing ComponentType and Trait resources, and deprecating old application and platform classes.

Changes

Getting Started

  • Quick Start Guide: Updated to use k3d, removed Backstage (v0.5), updated docker run command, added BuildPlane resource requirements, updated install script flags
  • Single Cluster: Replaced Kind with k3d, updated Helm commands with k3d values files, added port mapping details, removed Cilium CNI step, updated pod lists for v0.4, removed Backstage
  • Multi Cluster: Updated all 4 clusters (CP/DP/BP/OP) to k3d, updated script references, removed observer integration section, added inotify troubleshooting for VMs
  • Deploy First Component: Updated context to k3d-openchoreo, corrected resource types to use ComponentType/ComponentDeployment, simplified testing

API Reference - New Resources

  • ComponentType: Complete API documentation with schema syntax, CEL expressions, and examples (HTTP service, scheduled task, resource iteration)
  • Trait: Full documentation with patch system, JSONPatch operations, and examples (persistent volume, sidecar, resource limits)
  • ComponentDeployment: Environment-specific deployment documentation with override hierarchy and examples

API Reference - Deprecations

  • Platform Resources: Added deprecation notices to ServiceClass, WebApplicationClass, ScheduledTaskClass
  • Application Resources: Added deprecation notices to Service, WebApplication, ScheduledTask

Navigation

  • Updated sidebars.ts to include new resources (ComponentType, Trait, ComponentDeployment)
  • Marked deprecated resources in sidebar with "(Deprecated)" suffix

Related Issues

Part of the v0.4.0 release preparation

Checklist

  • Updated sidebars.ts if adding a new documentation page
  • Run npm run start to preview the changes locally
  • Run npm run build to ensure the build passes without errors
  • Verified all links are working (no broken links)

@Mirage20
Update Quick Start Guide for v0.4.0
72dcc82 
- Replace Kind with k3d infrastructure
- Update install script flag to --version
- Add ComponentTypes to foundation resources
- Remove Backstage references (v0.5 feature)
- Add Explore More section with demos
- Improve styling with step cards
- Update port references for workload gateway
@Mirage20
Update Single Cluster setup guide for v0.4.0
aeab272 
- Replace Kind with k3d infrastructure
- Update all Helm install commands with k3d values files
- Add port mapping details for all planes
- Update script references (add-data-plane.sh)
- Remove Cilium CNI installation step
- Update pod lists to match v0.4 deployments
- Remove Backstage installation (v0.5 feature)
- Update kubectl context references to k3d-openchoreo
- Add Colima DNS fix note
- Simplify cleanup to k3d cluster delete
@Mirage20
Update Multi Cluster setup guide for v0.4.0
0e25901 
- Replace Kind with k3d for all clusters (CP/DP/BP/OP)
- Update all Helm install commands with k3d values files
- Add port mapping details for all planes
- Update script references (add-data-plane.sh, add-build-plane.sh)
- Remove Cilium CNI installation steps
- Update pod lists to match v0.4 deployments
- Remove Backstage installation (v0.5 feature)
- Remove observer integration section
- Update kubectl context references to k3d-openchoreo-*
- Add Colima DNS fix note
- Add inotify limits troubleshooting for stuck clusters
- Simplify cleanup to k3d cluster delete
@Mirage20
Update Deploy First Component guide for v0.4.0
1b9feb6 
- Update kubectl context reference to k3d-openchoreo
- Update resource types to match v0.4 (ComponentType, ComponentDeployment)
- Update kubectl commands to use correct resource types
- Simplify curl test to use external gateway at localhost:9080
- Remove emoji checkboxes
- Update explanation of created resources
@Mirage20
Add ComponentType and Trait API reference docs
0f17d9d 
- Create new ComponentType API reference documentation
- Create new Trait API reference documentation
- Add deprecation notices to ServiceClass
- Add deprecation notices to WebApplicationClass
- Add deprecation notices to ScheduledTaskClass
- Update sidebars.ts to include new resources
- Mark deprecated classes in sidebar navigation
@Mirage20
Add ComponentDeployment and deprecate old application resources
06e43c9 
- Create ComponentDeployment API reference documentation
- Add deprecation notices to Service
- Add deprecation notices to WebApplication
- Add deprecation notices to ScheduledTask
- Update sidebars.ts to include ComponentDeployment
- Mark deprecated application resources in sidebar
@Mirage20 Mirage20 merged commit 6901afe into openchoreo:main Nov 16, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@JanakaSandaruwan JanakaSandaruwan JanakaSandaruwan approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Mirage20 @JanakaSandaruwan