Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add references to stable and latest docs versions #748

Merged
merged 1 commit into from
Jan 22, 2025
Merged

docs: add references to stable and latest docs versions #748

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,16 @@
[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)
[![Code coverage][codecov-image]][codecov-url]
[![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
Expand All @@ -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.
Expand Down
4 changes: 4 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
5 changes: 5 additions & 0 deletions docs/reference/troubleshooting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,11 @@ snap switch authd-<broker_name> --stable
snap refresh authd-<broker_name>
```

```{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)
Expand Down
Loading