From 3174b665d97ded7f0675e3ecbced84642f29efb6 Mon Sep 17 00:00:00 2001 From: shanecrowley Date: Wed, 22 Jan 2025 14:31:49 +0000 Subject: [PATCH] add references to stable and latest docs versions * updates README docs links to include stable and latest * adds comment on docs versions to homepage * adds comment on latest docs in troubleshooting section mentioning edge --- README.md | 12 ++++++++---- docs/index.md | 4 ++++ docs/reference/troubleshooting.md | 5 +++++ 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9c799cf0a..2095a2933 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,8 @@ [goreport-url]: https://goreportcard.com/report/github.com/ubuntu/authd [docs-image]: https://readthedocs.com/projects/canonical-authd/badge/?version=latest -[docs-url]: https://canonical-authd.readthedocs-hosted.com/en/latest/ +[docs-url-stable]: https://canonical-authd.readthedocs-hosted.com/en/stable/ +[docs-url-latest]: https://canonical-authd.readthedocs-hosted.com/en/latest/ [![Code quality][actions-image]][actions-url] [![License][license-image]](COPYING) @@ -23,7 +24,7 @@ [![Go Report Card][goreport-image]][goreport-url] [![Reference documentation][reference-documentation-image]][reference-documentation-url] -[![Documentation Status][docs-image]][docs-url] +[![Documentation Status][docs-image]][docs-url-stable] authd is an authentication daemon for cloud-based identity providers. It helps ensure the secure management of identity and access for Ubuntu machines anywhere @@ -34,8 +35,11 @@ supported and several other identity providers are under active development. ## Documentation -If you want to know more about using authd, refer to the -[official authd documentation][docs-url]. +To find out more about using authd, refer to the +[official authd documentation][docs-url-stable]. +If you are on an edge release then you can also read the +[latest development version of the documentation][docs-url-latest], +which may include features not yet available in the stable release. The documentation includes how-to guides on installing and configuring authd, in addition to information about authd architecture and troubleshooting. diff --git a/docs/index.md b/docs/index.md index 1b96acb7a..0e8589a96 100644 --- a/docs/index.md +++ b/docs/index.md @@ -41,8 +41,12 @@ These brokers allow you to authenticate against MS Entra ID or Google IAM using **Discussion** of product architecture ``` + ```` +Documentation for the [stable](https://canonical-authd.readthedocs-hosted.com/en/stable/) release of authd and the [latest](https://canonical-authd.readthedocs-hosted.com/en/latest/) development version are +both available. + --------- ## Project and community diff --git a/docs/reference/troubleshooting.md b/docs/reference/troubleshooting.md index 76a50625b..2a40d0f48 100644 --- a/docs/reference/troubleshooting.md +++ b/docs/reference/troubleshooting.md @@ -102,6 +102,11 @@ snap switch authd- --stable snap refresh authd- ``` +```{note} +If using an edge release, you can read the +[latest development version of the documentation](https://canonical-authd.readthedocs-hosted.com/en/latest/) +``` + ## Common issues and limitations ### File ownership on shared network resources (e.g. NFS, Samba)