Re: [docs] [yocto-docs PATCH] migration-guides: add placeholder files next release

Antonin Godard
2024-11-13T13:39:51Z

On Wed Nov 13, 2024 at 10:22 AM CET, Quentin Schulz wrote:
> Hi Antonin,
>
> On 11/13/24 9:31 AM, Antonin Godard wrote:
>> Hi Quentin,
>>
>> On Tue Nov 12, 2024 at 6:15 PM CET, Quentin Schulz via lists.yoctoproject.org wrote:
>>> Hi Antonin,
>>>
[...]
>>>> +Release 5.2 (walnascar)
>>>> +=======================
>>>> +
>>>> +.. toctree::
>>>> +
>>>> + migration-5.2
>>>> + release-notes-5.2
>>>
>>> If this file is always the same, we can make set_versions.py or
>>> something similar generate it.
>>
>> It evolves when minor updates are published (5.0.1, 5.0.2, etc.), so we would
>> need to count the number of releases based on existing tags for a branch. We
>> would also need to exclude some of those for older releases (for instance the
>> kirkstone branch does not contain release-5.1.rst).
>>
>> I'm not sure that the complexity is worth it?
>>
>
> We already autogenerate releases.rst which does list all major and minor
> releases based on existing tags.
>
> We know from which tag(s) we started to have release-notes and migration
> files.
>
> We could stop the generation of those files depending on the current tag
> we're building for, to prevent trying to include files that don't exist
> in older releases.
>
> We could also do the same trick we do for Supported Release Manuals and
> Outdated Release Manuals and just link to the newer
> docs.yoctoproject.org/X.Y.Z/migration-guides/release-X.Y.html
>
> Just ideas though :)
>
> Cheers,
> Quentin

I see, I'm taking a note, and I'll try to look into this at some point to see
what's worth automating or not. I know I also need to look into the releases.svg
autobuilder deployment, so maybe there's something to refactor here also.

In the meantime I'll send a v2 shortly with some improvements.

Thanks for your input and ideas!
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering