Skip to content

Commit

Permalink
[#3671] Update links in contributing docs (#3675)
Browse files Browse the repository at this point in the history
  • Loading branch information
ljupcovangelski authored Sep 2, 2022
1 parent 4be2658 commit a03151f
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/docs/guides/contributing-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_label: Contributing Components

:::warning

This functionality does not yet exist and is under development. With these docs, we aim to elicit feedback from our community (you!) and focus our development efforts. Currently, we do not offer support for 3rd party components, but we are working toward supporting this.
While you can already contribute components exposing them to users via the catalog is still under development.

:::

Expand All @@ -24,31 +24,33 @@ With every [installation of Airy](../getting-started/installation/introduction.m
5. frontend-inbox
6. frontend-control-center

Airy also provides a marketplace of _plug and play_ components that extend the functionality of your Airy instance. You can install them through the catalog page in the Control Center UI of your Airy Instance.
Airy also provides a marketplace of _plug and play_ components that extend the functionality of your Airy instance.
You can install them through the catalog page in the Control Center UI of your Airy Instance or by using the [install endpoint](../api/endpoints/components.md#install).

In the following, we will explain how to create, update and store components.

The Helm package and information on each component (except core components) are stored in an external repository managed by Airy called [airy-components](https://github.com/airyhq/airy-/airy-components). This repository is made up of directories where each directory contains a component's Helm package its description.
The Helm package and information on each component (except core components) are stored in an external repository managed by Airy called [catalog](https://github.com/airyhq/catalog).
This repository is made up of directories where each directory contains a component's metadata.

## The Component File Structure

Below is a model of the file structure of a single component inside the [`airy-components`](https://github.com/airyhq/airy-components) repository.
Below is a model of the file structure of a single component inside the [`catalog`](https://github.com/airyhq/catalog) repository.

```
airy-components/
catalog/
└── [COMPONENT_NAME]/
β”œβ”€β”€ description.yaml
└── helm/
└── [HELM CHART]
└── description.yaml
```

The `helm` directory contains all the files that make up the Helm package.
The `description.yaml` completely defines a component so that it can be installed and displayed in the UI catalog.

The `description.yaml` is the source-of-truth for every component. It includes a description of its functionality, pricing, availability, and version. This file is written by the component maintainer and rendered into the UI of the Control Center.
It contains a description of its functionality, availability, version, and importantly the url of the helm chart used for installation.
This file is written by the component maintainer and rendered into the UI of the Control Center.

:::note

Since all components are maintained by Airy, the versioning of every component is tied to the version of Airy. However, once we support 3rd party components, we will revisit our versioning system.
Since all components are maintained by Airy, the versioning of every component is tied to the version of Airy.
However, once we support 3rd party components, we will revisit our versioning system.

::::

Expand Down

0 comments on commit a03151f

Please sign in to comment.