From 4068c61988819bc80aae4bd757855648a72697cb Mon Sep 17 00:00:00 2001 From: Munish Chouhan Date: Wed, 29 Jan 2025 12:28:13 +0100 Subject: [PATCH] update docs (#790) * update docs --- configuration.md => docs/configuration.mdx | 6 +++--- docs/metrics.mdx | 4 +--- 2 files changed, 4 insertions(+), 6 deletions(-) rename configuration.md => docs/configuration.mdx (98%) diff --git a/configuration.md b/docs/configuration.mdx similarity index 98% rename from configuration.md rename to docs/configuration.mdx index d119cae16..f1b444264 100644 --- a/configuration.md +++ b/docs/configuration.mdx @@ -1,10 +1,10 @@ # Wave Application Configuration -Set Wave configuration values using environment variables or in [`config.yml`](./config.yml) configuration file +Set Wave configuration values using environment variables or in [`config.yml`](https://github.com/seqeralabs/wave/blob/master/config.yml) configuration file ### config.yml configuration -Declare YAML configuration values in [`config.yml`](./config.yml) +Declare YAML configuration values in [`config.yml`](https://github.com/seqeralabs/wave/blob/master/config.yml) ``` wave: mail: @@ -39,7 +39,7 @@ The generic format for the attributes is `wave.registries..userna You need to specify all the repositories you will use in the respective wave installation. Below are the standard format for known registries, but you can change registry name `(azurecr.io)` to specific one like `seqeralabs.azurecr.io `. -**Note**: Container registry credentials can be defined in [`config.yml`](./config.yml) too. These configurations are important for the wave authentication to the repositories used to push or pull artifacts. +**Note**: Container registry credentials can be defined in [`config.yml`](https://github.com/seqeralabs/wave/blob/master/config.yml) too. These configurations are important for the wave authentication to the repositories used to push or pull artifacts. - **`wave.registries.default`**: the default Docker registry for Wave. The default is `docker.io`, and it represents the Docker Hub. *Optional*. diff --git a/docs/metrics.mdx b/docs/metrics.mdx index 1d3104818..8ff5a1045 100644 --- a/docs/metrics.mdx +++ b/docs/metrics.mdx @@ -1,6 +1,4 @@ ---- -title: Usage metrics ---- +# Usage metrics Wave uses Redis to store its usage metrics for a specific date and/or a specific organization.