Skip to content

Commit

Permalink
docs: use Docusaurus admonitions syntax (#112)
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-mader authored Aug 26, 2024
1 parent 61490c1 commit e8ebbe8
Showing 1 changed file with 9 additions and 6 deletions.
15 changes: 9 additions & 6 deletions agent_application/CONFIGURATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,13 @@

A configuration file is used to configure UniCore. It is expected to be present in `agent_application/config.yaml`. An example can be found in [example-config.yaml](example-config.yaml). Values can also be set through the environment, preferably used to inject sensitive values or environment-specific values.

> [!NOTE]
> Environment variables **override** values specified in the configuration file.
:::info
Environment variables **override** values specified in the configuration file.
:::

> [!IMPORTANT]
> All environment variables need to be prefixed with `UNICORE__` to prevent conflicts with existing variables.
:::note
All environment variables need to be prefixed with `UNICORE__` to prevent conflicts with other unrelated variables.
:::

## General

Expand Down Expand Up @@ -39,7 +41,8 @@ A configuration file is used to configure UniCore. It is expected to be present

## Look and Feel

> [!NOTE]
> Setting display values is currently not supported through environment variables. Please refer to `config.yaml`.
:::info
Setting display values is currently not supported through environment variables. Please refer to `config.yaml`.
:::

<!-- TODO: DISPLAY_0_NAME: even configured through env vars? -->

0 comments on commit e8ebbe8

Please sign in to comment.