diff --git a/docs/content/advanced/metrics/prometheus.md b/docs/content/advanced/metrics/prometheus.md index f5d7c5dc..71856c2d 100644 --- a/docs/content/advanced/metrics/prometheus.md +++ b/docs/content/advanced/metrics/prometheus.md @@ -37,6 +37,6 @@ You can use the following Grafana dashboard to visualize the metrics: /// note | Unofficial -The Grafana dashboard is not official and is not maintained by the wg-easy team. If you have any issues with the dashboard, please contact the author of the dashboard. +The Grafana dashboard is not official and is not maintained by the `wg-easy` team. If you have any issues with the dashboard, please contact the author of the dashboard. See [#1299](https://github.com/wg-easy/wg-easy/pull/1299) for more information. /// diff --git a/docs/content/contributing/issues-and-pull-requests.md b/docs/content/contributing/issues-and-pull-requests.md index 82ace683..c6a58757 100644 --- a/docs/content/contributing/issues-and-pull-requests.md +++ b/docs/content/contributing/issues-and-pull-requests.md @@ -24,9 +24,9 @@ Maintainers take the time to improve on this project and help by solving issues ### Filing a Bug Report -Thank you for participating in this project and reporting a bug. wg-easy is a community-driven project, and each contribution counts! +Thank you for participating in this project and reporting a bug. `wg-easy` is a community-driven project, and each contribution counts! -Maintainers and moderators are volunteers. We greatly appreciate reports that take the time to provide detailed information via the template, enabling us to help you in the best and quickest way. Ignoring the template provided may seem easier, but discourages receiving any support (_via assignment of the label `meta/no template - no support`_). +Maintainers and moderators are volunteers. We greatly appreciate reports that take the time to provide detailed information via the template, enabling us to help you in the best and quickest way. Ignoring the template provided may seem easier, but discourages receiving any support. Markdown formatting can be used in almost all text fields (_unless stated otherwise in the description_). diff --git a/docs/content/examples/tutorials/docker-run.md b/docs/content/examples/tutorials/docker-run.md index a2873689..4e865f89 100644 --- a/docs/content/examples/tutorials/docker-run.md +++ b/docs/content/examples/tutorials/docker-run.md @@ -14,7 +14,7 @@ docker network create \ -To automatically install & run wg-easy, simply run: +To automatically install & run `wg-easy`, simply run: ```shell docker run -d \ diff --git a/docs/content/examples/tutorials/traefik.md b/docs/content/examples/tutorials/traefik.md index 3d9ad410..6bbed1e4 100644 --- a/docs/content/examples/tutorials/traefik.md +++ b/docs/content/examples/tutorials/traefik.md @@ -146,7 +146,7 @@ sudo docker-compose up -d You can no access the Traefik dashboard at `https://traefik.$example.com$` with the credentials you set in `traefik_dynamic.yml`. -## Add Labels to wg-easy +## Add Labels to `wg-easy` To add labels to your `wg-easy` service, you can add the following to your `docker-compose.yml` file: @@ -174,7 +174,7 @@ networks: external: true ``` -## Restart wg-easy +## Restart `wg-easy` ```shell cd /etc/docker/containers/wg-easy diff --git a/docs/content/getting-started.md b/docs/content/getting-started.md index 7ddf6ecf..759d5176 100644 --- a/docs/content/getting-started.md +++ b/docs/content/getting-started.md @@ -4,7 +4,7 @@ hide: - navigation --- -This page explains how to get started with wg-easy. The guide uses Docker Compose as a reference. In our examples, we mount the named volume `etc_wireguard` to `/etc/wireguard` inside the container. +This page explains how to get started with `wg-easy`. The guide uses Docker Compose as a reference. In our examples, we mount the named volume `etc_wireguard` to `/etc/wireguard` inside the container. ## Preliminary Steps @@ -84,7 +84,7 @@ To stop the container, issue the following command: sudo docker compose down ``` -/// danger | Using the Correct Commands For Stopping and Starting wg-easy +/// danger | Using the Correct Commands For Stopping and Starting `wg-easy` **Use `sudo docker compose up / down`, not `sudo docker compose start / stop`**. Otherwise, the container is not properly destroyed and you may experience problems during startup because of inconsistent state. /// diff --git a/docs/content/index.md b/docs/content/index.md index 92532129..ae9b30f1 100644 --- a/docs/content/index.md +++ b/docs/content/index.md @@ -11,7 +11,7 @@ hide: **Make sure** to select the correct version of this documentation! It should match the version of the image you are using. The default version corresponds to the `:latest` image tag - [the most recent stable release][docs-tagging]. /// -This documentation provides you not only with the basic setup and configuration of wg-easy but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more. +This documentation provides you not only with the basic setup and configuration of `wg-easy` but also with advanced configuration, elaborate usage scenarios, detailed examples, hints and more. [docs-tagging]: ./getting-started.md#tagging-convention