Improve Overview section of OpenChoreo documentation#83
Conversation
| --- | ||
|
|
||
| # What is OpenChoreo? | ||
| OpenChoreo is a complete, open-source Internal Developer Platform (IDP) designed for platform engineering (PE) teams who want to streamline developer workflows and deliver Internal Developer Portals without having to build everything from scratch. |
There was a problem hiding this comment.
I am wondering whether we need complete word here? What does a complete IDP mean?
There was a problem hiding this comment.
Let's use the term comprehensive instead of complete.
| OpenChoreo is made up of several key components that work together to deliver a complete IDP. | ||
|
|
||
| ## How OpenChoreo Solves It | ||
| <!--  --> |
There was a problem hiding this comment.
I think we don't have this image. Shall we put it in the same directory? WDYT?
There was a problem hiding this comment.
I'll add images soon. Thanks.
| - A **Control Plane** that understands and enforces these APIs with GitOps support | ||
| - A **built-in CI system** | ||
| - An **opinionated Data Plane** with runtime enforcement of design-time semantics | ||
| - Built-in **Security**, **networking** and **observability** integrations |
There was a problem hiding this comment.
| - Built-in **Security**, **networking** and **observability** integrations | |
| - Built-in **security**, **networking** and **observability** integrations |
Any reason to capitalize this but not others?
| OpenChoreo is architected as a modular, Kubernetes-native control plane that integrates deeply with other open-source projects to provide a comprehensive, extensible Internal Developer Platform (IDP). | ||
|
|
||
| ## Overview | ||
| The Control Plane acts as the orchestrator, transforming high-level platform and developer intent into actionable workloads deployed across CI, Data planes, while wiring them into the Observability plane for visibility. |
There was a problem hiding this comment.
I am wondering whether we should say workloads deployed across CI as we use the workload terminology for data plane deployments. How about workflows deployed across CI?
|
Other than the above two changes, I am good with other changes. Can you also add these changes to the |
2 participants
Purpose
My goal is to bring consistency to OpenChoreo documentation. I'll work on the Overview section as the first phase of this effort.
I've updated the
what-is-openchoreo.mdpage to introduce OpenChoreo to newcomers. This page should work for developers, platform engineers and decision makers who are evaluating OpenChoreo.I also updated the Architecture page with images. The existing page is great. It has lots of useful details. I'm planning to add a new section called
Platform Componentsthat has individual pages for each OpenChoreo component and we can move all those details there. @Mirage20, please note.Checklist
sidebars.tsif adding a new documentation pagenpm run startto preview the changes locallynpm run buildto ensure the build passes without errors