airy
airy copied to clipboard
[#3558] Docs for Contributing and Defining Components
The purpose of this PR is to organize discussions around how we want to maintain and update components. I have tried to capture our internal discussion on this issue in this initial draft. This PR also includes an update to our definition of Components
in the glossary (#3294). Please amend/discuss/comment!
The secondary purpose is to merge these docs before we implement the proposed change. This way, we can adopt a "docs-driven" development approach.
The primary change proposed is the creation of an external repository where the Helm package and information on components are stored. The benefits of this approach are:
- We can update information on components between release cycles (if needed).
- The
description.yaml
associated with a connector file becomes the "source of truth" on components and can be standardized for the Control Center. - The helm files can help potential enterprise clients technically audit us.
- We begin to create the infrastructure to support third-party components.