Re: [docs] [PATCH 1/2] poky.yaml: introduce DISTRO_LATEST_TAG

["Antonin Godard" <antonin.godard@bootlin.com>]

On Wed Apr 23, 2025 at 11:56 AM CEST, Quentin Schulz wrote:
> Hi Antonin,
>
> On 4/23/25 11:33 AM, Antonin Godard wrote:
> [...]
>>> I don't think we should be using &DISTRO; anymore? Most of the time we
>>> don't want to be printing .999 on the landing page of
>>> docs.yoctoproject.org! For the dev page, that's different.
>> 
>> I would like to agree, but at the same time, wouldn't it be confusing to have a
>> real tag (e.g. 5.1.8) when reading for the latest tip of the branch? It would be
>
> Does it matter? We should only be doing bug fixing and ideally without 
> breaking backward compatibility in a given release branch.
> Again, the development (master) branch is a different story here.
>
>> somewhat accurate, but not _stricty_ accurate as to which version of the doc you
>> are actually reading (the latest tip).
>> 
>
> The issue is that this tag simply doesn't exist so we should absolutely 
> never use it when code is involved, as the instructions will simply not 
> work.

Right, so the code parts of the docs should be adapted to use DISTRO_LATEST_TAG,
but I still think using DISTRO in the textual parts is useful to distinguish a
branch tip version of the docs and a tagged version of the docs.

>> I'm trying to think of a way to make it clear that 999 represent the branch's
>> tip.
>> 
>
> I'm failing to see how it is relevant to the user that the docs are 
> built from the branch's tip instead of the tag?

There might be a reason that goes beyond my work on the docs, but it is kind of
useful to me to monitor changes as we go, or just to provides up-to-date links
to people.

It is questionable that this should be the default landing page though.

> BTW, it seems like once you're on a tagged release, you cannot go back 
> to the .999 from the dropdown menu, is that intended?

Sounds like a bug to me!

Thanks,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com