Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
142 lines (92 loc) · 3.07 KB

CONTRIBUTING.md

File metadata and controls

142 lines (92 loc) · 3.07 KB

Contributing

File organization

Repository Structure

/charts contains the source of custom Helm charts.

Note

Helm Chart Releaser doesn't support multiple chart directories ou multiple levels so all charts must be in charts repository.

/docs provides the source of the website, with in particular instructions for:

  • Installing popular applications (/docs/application-guides)
  • Using custom charts (/docs/custom-charts)

Custom Helm charts

Check manifest during creation

Lint the chart:

helm lint

Generate the Kubernetes manifest yaml:

helm template myapp . -f values.yaml --namespace myns > temp.yaml

Deploy from sources

Install the application:

helm upgrade --install myapp . -f values.yaml --namespace myns --create-namespace

Run locally CI checks

Lint charts with KubeLinter:

kube-linter lint charts --config .kube-linter.yaml

Documentation website

Static Site Generator

The website is built with VitePress and:

The project was generated using npx vitepress init.

Website files are in docs folder.

For configuration, look at docs/.vitepress/config.mts.

Local review

Install dependencies:

npm install

Run the website with:

npm run docs:dev

Markdown tips

  • Use Alerts when it makes sense:
> [!NOTE]
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]
> Crucial information necessary for users to succeed.

> [!WARNING]
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.
  • Containers
::: info
This is an info box.
:::

::: tip
This is a tip.
:::

::: warning
This is a warning.
:::

::: danger
This is a dangerous warning.
:::

::: details
This is a details block.
:::