airy icon indicating copy to clipboard operation
airy copied to clipboard

[#3558] Docs for Contributing and Defining Components

Open armanjindal opened this issue 1 year ago • 0 comments

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:

  1. We can update information on components between release cycles (if needed).
  2. The description.yaml associated with a connector file becomes the "source of truth" on components and can be standardized for the Control Center.
  3. The helm files can help potential enterprise clients technically audit us.
  4. We begin to create the infrastructure to support third-party components.

armanjindal avatar Aug 11 '22 13:08 armanjindal