From 00de5c711a1f2eab85e02d36f48892864dca1485 Mon Sep 17 00:00:00 2001 From: sven Date: Tue, 15 Nov 2022 10:28:07 +0100 Subject: [PATCH] docs(contributing): add link descriptions and update wording --- docs/content/contributing/documentation.md | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/docs/content/contributing/documentation.md b/docs/content/contributing/documentation.md index ead44d0b3..3911abe4a 100644 --- a/docs/content/contributing/documentation.md +++ b/docs/content/contributing/documentation.md @@ -15,10 +15,14 @@ Let's see how. ### General -This [documentation](https://doc.traefik.io/traefik/) is built with [mkdocs](https://mkdocs.org/). +This [documentation](https://doc.traefik.io/traefik/ "Link to the official Traefik documentation") is built with [MkDocs](https://mkdocs.org/ "Link to website of MkDocs"). ### Method 1: `Docker` and `make` +Please make sure you have the following requirements installed: + +- [Docker](https://www.docker.com/ "Link to website of Docker") + You can build the documentation and test it locally (with live reloading), using the `docs-serve` target: ```bash @@ -43,9 +47,12 @@ $ make docs-build ... ``` -### Method 2: `mkdocs` +### Method 2: `MkDocs` -First, make sure you have `python` and `pip` installed. +Please make sure you have the following requirements installed: + +- [Python](https://www.python.org/ "Link to website of Python") +- [pip](https://pypi.org/project/pip/ "Link to the website of pip on PyPI") ```bash $ python --version @@ -54,7 +61,7 @@ $ pip --version pip 1.5.2 ``` -Then, install mkdocs with `pip`. +Then, install MkDocs with `pip`. ```bash pip install --user -r requirements.txt @@ -87,7 +94,7 @@ Running ["HtmlCheck", "ImageCheck", "ScriptCheck", "LinkCheck"] on /app/site/bas !!! note "Clean & Verify" - If you've made changes to the documentation, it's safter to clean it before verifying it. + If you've made changes to the documentation, it's safer to clean it before verifying it. ```bash $ make docs