docs: update authd availability for Ubuntu 26.04 LTS archive#1373
docs: update authd availability for Ubuntu 26.04 LTS archive#1373nooreldeenmansour wants to merge 1 commit intomainfrom
Conversation
8c3fcaf to
c5d3e84
Compare
6893154 to
a4f8299
Compare
0b74a4d to
140bc6d
Compare
docs/howto/install-authd.md
Outdated
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. | ||
|
|
||
| To add this PPA to your system's software sources, run the following command: | ||
| **Ubuntu 24.04 LTS (Noble):** `authd` must be installed from the [stable PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd): |
There was a problem hiding this comment.
I doubt that mentioning the release names are a benefit to our users, I would omit them to make it look a bit cleaner. Also, very nitpicky, but for consistency with how it's done above on the same page, the : should not be bold.
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. | |
| To add this PPA to your system's software sources, run the following command: | |
| **Ubuntu 24.04 LTS (Noble):** `authd` must be installed from the [stable PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd): | |
| **Ubuntu 26.04 LTS and later**: `authd` is available directly from the Ubuntu archive. | |
| **Ubuntu 24.04 LTS**: `authd` must be installed from the [stable PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd): |
There was a problem hiding this comment.
Our convention is that we can mention the release name or not, but that we should always mention if it is an LTS.
There was a problem hiding this comment.
But I agree: I don't think we need to use the release name. Just to be clear.
docs/reference/landscape-deploy.md
Outdated
| :::{note} | ||
| On Ubuntu 24.04 LTS (Noble), `authd` is not in the Ubuntu archive. Add the following | ||
| line at the start of your script, before `apt-get install authd`: | ||
|
|
||
| ```shell | ||
| add-apt-repository -y ppa:ubuntu-enterprise-desktop/authd | ||
| ``` | ||
|
|
||
| On Ubuntu 26.04 LTS (Resolute) and later, this step is not required. | ||
| ::: | ||
|
|
There was a problem hiding this comment.
I like this note, I think it looks better than the
Ubuntu 26.04 LTS (Resolute) and later: [...]
Ubuntu 24.04 LTS (Noble): [...]
used in install-authd.md and cloud-init-deploy.md. Maybe we can use a similar note there too.
However, one aspect that's not ideal is that we don't tell users of 25.10 what to do (they also need the PPA). Probably not worth spending much time on since 25.10 will be end-of-life in July.
There was a problem hiding this comment.
we don't tell users of 25.10 what to do
True, although it is somewhat implicit in the wording (if it's required for 24.04, but not required for 26.04, it probably is required for the one in between). Given what you say about its EOL, I would think it's OK for now, or at least until someone asks.
I like this note
Me too. A few things though:
- I would consider only wrapping information about Ubuntu 24.04 LTS and the relevant command in the note block (treat 26.04 as the default). In this section, I think it can just start with "For Ubuntu 26.04 LTS, install the authd deb and the broker snap:" so that the line on Resolute in the block is not needed.
- I think it's useful to have a labelled note block in this case. Something like "Before installing on 24.04", "Additional step for 24.04", or "PPA required for installing on Ubuntu 24.04". To do this, use
{admonition} Your labeland add:class: noteas the first line within the block. - As already mentioned, we probably don't need to use the release names. I'm not sure it adds much value in this context.
(edit: adding suggestions)
|
Thanks @nooreldeenmansour . I was planning to do this as a part of UDENG-9498, but will review this PR instead. |
|
@edibotopic I wasn’t aware of that ticket. I’ll make sure to coordinate and check for any related documentation work beforehand going forward. |
edibotopic
left a comment
There was a problem hiding this comment.
Great, timely work @nooreldeenmansour !
I've added some suggestions for you to consider.
docs/howto/install-authd.md
Outdated
| ## System requirements | ||
|
|
||
| * Distribution: Ubuntu Desktop 24.04 LTS or Ubuntu Server 24.04 LTS | ||
| * Distribution: Ubuntu Desktop 24.04 LTS or later, or Ubuntu Server 24.04 LTS or later |
There was a problem hiding this comment.
| * Distribution: Ubuntu Desktop 24.04 LTS or later, or Ubuntu Server 24.04 LTS or later | |
| * Ubuntu: Desktop or Server editions | |
| * Version: Ubuntu 24.04 LTS or later |
I find this line a little messy (indicated by three uses of "or" in sequence).
My suggestion is to split Distribution into two items: Ubuntu and Version.
There was a problem hiding this comment.
I've applied your suggestion, but what about using the word Release instead of Version
We perhaps can drop the word Ubuntu from the second bullet-point, as it exists in the bullet point above it. What do you think?
There was a problem hiding this comment.
No problem using Release instead of Version.
And, agreed: we can drop "Ubuntu" from the second bullet.
docs/howto/install-authd.md
Outdated
| ## Install authd | ||
|
|
||
| You can install authd from the [stable PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd). | ||
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. |
There was a problem hiding this comment.
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. | |
| On Ubuntu 26.04 LTS, `authd` is available directly from the Ubuntu archive. |
I don't think we need the "and later" here? What is "later" currently?
I also don't think we need the additional formatting or the release name.
There was a problem hiding this comment.
Should I remove the and later from the SECURITY.md file too?
We provide security updates for the latest version of `authd` on each supported Ubuntu LTS release.
**Ubuntu 26.04 LTS and later**: `authd` is available directly from the Ubuntu archive.
**Ubuntu 24.04 LTS and earlier supported LTS releases**: `authd` is not in the Ubuntu archive and must be installed using the stable PPA.
One could argue that for upcoming releases, they will be in archive, so we won't have to update it for each LTS release, unless we wish to make it more explicit. What do you think?
There was a problem hiding this comment.
My initial thought was that a "later" currently doesn't exist.
However, this can be interpreted as a kind of commitment, and in that sense it's OK, as long as we fulfill that commitment.
So we can just leave it as is.
docs/howto/install-authd.md
Outdated
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. | ||
|
|
||
| To add this PPA to your system's software sources, run the following command: | ||
| **Ubuntu 24.04 LTS (Noble):** `authd` must be installed from the [stable PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd): |
There was a problem hiding this comment.
As mentioned in https://github.com/canonical/authd/pull/1373/changes#r3021197348, consider wrapping the 24.04 details in a note block.
docs/reference/cloud-init-deploy.md
Outdated
| Add the authd PPA to the system's software sources and install authd: | ||
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive: | ||
|
|
||
| ```yaml | ||
| packages: | ||
| - authd | ||
| ``` | ||
|
|
||
| **Ubuntu 24.04 LTS (Noble):** `authd` must be installed from the stable PPA. Add it to the system's software sources: |
There was a problem hiding this comment.
docs/reference/landscape-deploy.md
Outdated
| @@ -34,14 +34,24 @@ CLIENT_ID=<CLIENT_ID> | |||
|
|
|||
| Install the authd deb and the broker snap: | |||
There was a problem hiding this comment.
| Install the authd deb and the broker snap: | |
| For Ubuntu 26.04 LTS, install the authd deb and the broker snap from the archive: |
docs/reference/landscape-deploy.md
Outdated
| :::{note} | ||
| On Ubuntu 24.04 LTS (Noble), `authd` is not in the Ubuntu archive. Add the following | ||
| line at the start of your script, before `apt-get install authd`: |
There was a problem hiding this comment.
| :::{note} | |
| On Ubuntu 24.04 LTS (Noble), `authd` is not in the Ubuntu archive. Add the following | |
| line at the start of your script, before `apt-get install authd`: | |
| :::{admonition} Add PPA before installing on Ubuntu 24.04 | |
| Add the following | |
| line at the start of your script, before `apt-get install authd`, to add the PPA: |
SECURITY.md
Outdated
| If you are unsure of your version, please run the following command in a terminal and check which PPA `authd` is installed from: | ||
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. | ||
|
|
||
| **Ubuntu 24.04 LTS (Noble) and earlier supported LTS releases:** `authd` is not in the Ubuntu archive and must be installed via the stable PPA. |
There was a problem hiding this comment.
| **Ubuntu 24.04 LTS (Noble) and earlier supported LTS releases:** `authd` is not in the Ubuntu archive and must be installed via the stable PPA. | |
| **Ubuntu 24.04 LTS and earlier supported LTS releases:** `authd` is not in the Ubuntu archive and must be installed using the stable PPA. |
Avoid Latinisms when there is a straightforward alternative.
SECURITY.md
Outdated
| We provide security updates for the latest version of `authd` on each supported Ubuntu LTS release. | ||
|
|
||
| If you are unsure of your version, please run the following command in a terminal and check which PPA `authd` is installed from: | ||
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. |
There was a problem hiding this comment.
| **Ubuntu 26.04 LTS (Resolute) and later:** `authd` is available directly from the Ubuntu archive. | |
| **Ubuntu 26.04 LTS and later:** `authd` is available directly from the Ubuntu archive. |
SECURITY.md
Outdated
|
|
||
| An [edge PPA](https://launchpad.net/~ubuntu-enterprise-desktop/+archive/ubuntu/authd-edge) provides the latest development builds, but is not recommended for production use and does not receive security support. | ||
|
|
||
| If you are unsure of your version, please run the following command in a terminal and check which channel `authd` is installed from: |
There was a problem hiding this comment.
| If you are unsure of your version, please run the following command in a terminal and check which channel `authd` is installed from: | |
| If you are unsure of your version, please run the following command in a terminal to check which channel `authd` is installed from: |
|
@nooreldeenmansour @adombeck --- I'm wondering should we also look at this page: https://canonical-ubuntu-documentation-library--1373.com.readthedocs.build/authd/1373/howto/changing-versions/ . Specifically the section: This section made more sense when the default install was the stable PPA. But now it is only mentioned as the install option for 24.04. The instructions wouldn't be appropriate for someone switching back and forth between the 26.04 package and the edge PPA. We could reword/rewrite it slightly to be more general, covering switching between stable and edge for PPA users on 24.04 (if we need to include that) but also using the edge PPA instead of the archive package (for those who are interested). We would eventually keep the focus on the archive package in install.md, for example, but be able to point to this changing-versions.md where necessary. Related to #1341 |
a88f378 to
452468b
Compare
452468b to
48b6dba
Compare
UDENG-9585