Skip to content
This repository was archived by the owner on Sep 15, 2022. It is now read-only.

Commit 020a199

Browse files
authored
Add a note about the testing addon (#111)
1 parent 7ba8ecb commit 020a199

File tree

2 files changed

+8
-15
lines changed

2 files changed

+8
-15
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,26 @@
22

33
## Overview
44

5-
This repository contains addons which the [Helm Broker](https://kyma-project.io/docs/master/components/helm-broker/#overview-overview) uses. It allows you to choose a set of addons you want to use, define your own addons, and configure the Helm Broker to use them.
5+
This repository contains addons which the Helm Broker uses. For more information on what the Helm Broker is, how it uses addons, and how to create your own addons, read the official Helm Broker [documentation](https://kyma-project.io/docs/master/components/helm-broker/#overview-overview).
66

77
## Usage
88

9-
The `addons` folder contains sources of addons and `index.yaml` files that are available in [releases](https://github.com/kyma-project/addons/releases). To learn more about the release process, read [this](docs/releases.md) document.
10-
To learn how to configure the Helm Broker to use different set of addons, read the [Helm Broker configuration](https://kyma-project.io/docs/master/components/helm-broker/#configuration-configuration) document.
9+
The `addons` folder contains sources of addons and index files that are available in [releases](https://github.com/kyma-project/addons/releases). Choose a set of addons you want to use, add your own addons, and configure the Helm Broker to fetch them.
1110

1211
## Development
1312

14-
Develop your own remote addons repository forked from the original repository. Read [this](docs/getting-started.md) document to learn how. On your fork, you can [create your own addons](https://kyma-project.io/docs/master/components/helm-broker/#details-details). Read the [`CONTRIBUTING.md`](CONTRIBUTING.md) document that includes the contributing rules specific for this repository.
13+
Develop your own addons repository forked from the original repository. Read [this](docs/getting-started.md) document to learn how. On your fork, you can create your own addons. Your addons must follow the [addons template](https://kyma-project.io/docs/master/components/helm-broker/#details-create-addons) and your addons repository must have the specified [structure](https://kyma-project.io/docs/master/components/helm-broker/#details-create-addons-repository) so that the Helm Broker can use it. Read the [`CONTRIBUTING.md`](CONTRIBUTING.md) document that includes the contributing rules specific for this repository.
14+
15+
>**TIP:** You can base your addon on the [`testing` addon](addons/testing-0.0.1) that uses all functionality provided by the addon specification.
1516
1617
### Project structure
1718

1819
The repository has the following structure:
1920

2021
```
2122
├── .github # Pull request and issue templates
22-
├── bin # Tools used by Travis CI
23-
├── addons # Sources of addons
23+
├── addons # Sources of addons
24+
├── bin # Tools used by Travis CI
2425
├── docs # Documentation source files
2526
└── scripts # Scripts and tools which check and create addons
2627
```

addons/redis-0.0.3/README.md

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
```
2-
_____ _ _
3-
| __ \ | (_)
4-
| |__) |___ __| |_ ___
5-
| _ // _ \/ _` | / __|
6-
| | \ \ __/ (_| | \__ \
7-
|_| \_\___|\__,_|_|___/
8-
9-
```
1+
# Redis
102

113
## Overview
124

0 commit comments

Comments
 (0)