From b59371941e42104e5be67a35c55c010a5292f8d1 Mon Sep 17 00:00:00 2001 From: Clement Michaud Date: Sat, 13 Oct 2018 10:46:13 +0200 Subject: [PATCH] Fix broken links in documentation. --- docs/deployment.md | 4 ++-- docs/{getting_started.md => getting-started.md} | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) rename docs/{getting_started.md => getting-started.md} (95%) diff --git a/docs/deployment.md b/docs/deployment.md index d54de988f..53c077ad9 100644 --- a/docs/deployment.md +++ b/docs/deployment.md @@ -33,11 +33,11 @@ environment. -**Authelia** can also be used on top of Kubernetes using the nginx ingress +**Authelia** can also be used on top of Kubernetes using the nginx ingress controller. Please refer to the following [README](../example/kube/README.md) for more information. - [config.template.yml]: ../config.template.yml +[Getting Started]: ./getting-started.md diff --git a/docs/getting_started.md b/docs/getting-started.md similarity index 95% rename from docs/getting_started.md rename to docs/getting-started.md index 06673f735..27163d65d 100644 --- a/docs/getting_started.md +++ b/docs/getting-started.md @@ -1,4 +1,4 @@ -# Getting started +# Getting Started **Authelia** can be tested in a matter of seconds with docker-compose based on the latest image available on [Dockerhub] or by building the latest version @@ -62,7 +62,7 @@ following command: ## From source -To deploy **Authelia** from source, follow the [Build] manual and run the +To deploy **Authelia** from source, follow the [build] manual and run the following commands: ./scripts/example-commit/deploy-example.sh @@ -96,5 +96,6 @@ for testing only. Enjoy! +[config.template.yml]: ../config.template.yml [DockerHub]: https://hub.docker.com/r/clems4ever/authelia/ -[Build]: ./docs/build.md +[Build]: ./build.md