From 0da770d900391160f89f13d0a00b2feed913e3f4 Mon Sep 17 00:00:00 2001 From: James Elliott Date: Thu, 15 Jul 2021 13:21:47 +1000 Subject: [PATCH] docs: misc fixes (#2186) This fixes misc broken links in the docs as well as an invalid viewBox element. --- docs/_layouts/default.html | 2 +- docs/configuration/access-control.md | 2 +- docs/configuration/index.md | 2 +- docs/configuration/storage/sqlite.md | 2 +- docs/deployment/deployment-ha.md | 1 - docs/features/2fa/security-key.md | 4 ++-- docs/features/password-reset.md | 2 +- 7 files changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 8026e9be3..fa6300c6a 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -40,7 +40,7 @@ layout: table_wrappers - + Survey contribution diff --git a/docs/configuration/access-control.md b/docs/configuration/access-control.md index b287a4c66..16886f5fd 100644 --- a/docs/configuration/access-control.md +++ b/docs/configuration/access-control.md @@ -381,7 +381,7 @@ access in desired situations. Examples include denying access to an API that has ### bypass This policy skips all authentication and allows anyone to use the resource. This policy is not available with a rule -that includes a [subject](#Subjects) restriction because the minimum authentication level required to obtain information +that includes a [subject](#subject) restriction because the minimum authentication level required to obtain information about the subject is [one_factor](#one_factor). ### one_factor diff --git a/docs/configuration/index.md b/docs/configuration/index.md index b8063ea44..b5ef5046b 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -103,7 +103,7 @@ required: no The key `skip_verify` completely negates validating the certificate of the backend service. This is not recommended, -instead you should tweak the `server_name` option, and the global option [certificates_directory](./miscellaneous.md#certificates-directory). +instead you should tweak the `server_name` option, and the global option [certificates_directory](./miscellaneous.md#certificates_directory). ### Minimum Version
diff --git a/docs/configuration/storage/sqlite.md b/docs/configuration/storage/sqlite.md index e5d16db5d..df99a6b5a 100644 --- a/docs/configuration/storage/sqlite.md +++ b/docs/configuration/storage/sqlite.md @@ -12,7 +12,7 @@ If you don't have a SQL server, you can use [SQLite](https://en.wikipedia.org/wi However please note that this setup will prevent you from running multiple instances of Authelia since the database will be a local file. -Use of this storage provider leaves Authelia [stateful](../features/statelessness.md). It's important in highly +Use of this storage provider leaves Authelia [stateful](../../features/statelessness.md). It's important in highly available scenarios to use one of the other providers, and we highly recommend it in production environments, but this requires you setup an external database. diff --git a/docs/deployment/deployment-ha.md b/docs/deployment/deployment-ha.md index 19f47912c..eecb7b922 100644 --- a/docs/deployment/deployment-ha.md +++ b/docs/deployment/deployment-ha.md @@ -57,5 +57,4 @@ an infrastructure on bare metal. We would be more than happy to review any PR on [config.template.yml]: https://github.com/authelia/authelia/blob/master/config.template.yml [Getting Started]: ../getting-started.md -[Deployment for Devs]: ./deployment-dev.md [Kubernetes]: https://kubernetes.io/ diff --git a/docs/features/2fa/security-key.md b/docs/features/2fa/security-key.md index a56dda9ee..332e957ef 100644 --- a/docs/features/2fa/security-key.md +++ b/docs/features/2fa/security-key.md @@ -9,7 +9,7 @@ grand_parent: Features # Security Keys **Authelia** supports hardware-based second factors leveraging security keys like -[Yubikeys](Yubikey). +[YubiKey]'s. Security keys are among the most secure second factor. This method is already supported by many major applications and platforms like Google, Facebook, Github, @@ -60,4 +60,4 @@ and might even be enabled on some of them. Please be sure your browser supports U2F and that the feature is enabled to make the option available in **Authelia**. -[Yubikey]: https://www.yubico.com/products/yubikey-hardware/yubikey4/ +[YubiKey]: https://www.yubico.com/products/yubikey-5-overview/ diff --git a/docs/features/password-reset.md b/docs/features/password-reset.md index 0628637c8..7e1c3f729 100644 --- a/docs/features/password-reset.md +++ b/docs/features/password-reset.md @@ -8,7 +8,7 @@ nav_order: 4 # Password Reset **Authelia** provides a workflow to let users reset their password when they lose it. -To disable reset password functionality please see the [configuration docs](../configuration/authentication/index.md#disabling-reset-password). +To disable reset password functionality please see the [configuration docs](../configuration/authentication/index.md#disable_reset_password). A simple click on `Reset password?` for starting the process. Note that resetting a password requires a new identity verification using the e-mail of the user.