Update documentation for v0.4.0 release #119
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- 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
- 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
- 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
- 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
- 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
- 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
JanakaSandaruwan
approved these changes
Nov 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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
API Reference - New Resources
API Reference - Deprecations
Navigation
sidebars.tsto include new resources (ComponentType, Trait, ComponentDeployment)Related Issues
Part of the v0.4.0 release preparation
Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors