Re: [docs] [PATCH yocto-autobuilder-helper] scripts/run-docs-build: stop using the "transition" branch

[Nicolas Dechesne <nicolas.dechesne@linaro.org>]

[-- Attachment #1: Type: text/plain, Size: 2814 bytes --]

On Fri, Dec 3, 2021 at 11:03 AM Quentin Schulz <
quentin.schulz@theobroma-systems.com> wrote:

> Hi Nicolas,
>
> On Fri, Dec 03, 2021 at 10:49:40AM +0100, Nicolas Dechesne wrote:
> > On Fri, Dec 3, 2021 at 10:34 AM Quentin Schulz <
> > quentin.schulz@theobroma-systems.com> wrote:
> >
> > > On Wed, Dec 01, 2021 at 02:59:49PM +0100, Michael Opdenacker wrote:
> > > > No longer necessary now that the transition from DocBook to Sphinx is
> > > over
> > > >
> > > > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
> > >
> > > Reviewed-by: Quentin Schulz <foss+yocto@0leil.net>
> > >
> >
> > I don't understand. With this change, we no longer build the pages we
> > reference here:
> >
> https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_releases.html-23outdated-2Drelease-2Dmanuals&d=DwIBaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=nyCl21erajBNcx6SkCKI_BEntNgbh6114vcdWp_vB5yDzorVFjmzdqp0WXIIpQyK&s=rw5wG0nk_9KQ8RLvE1-sbSicy4NslWaeMwoyTSUuIyY&e=
> >
> > Or am I missing here?
> >
>
> Indeed. But this should be fixed, because we should handle this the same
> way documentation/releases.html is, with a common one across all
> releases. With the current implementation, only master has a list of all
> outdated releases. e.g.
> https://docs.yoctoproject.org/3.3/releases.html#outdated-release-manuals
> does not exist, but
> https://docs.yoctoproject.org/releases.html#outdated-release-manuals
> does (and weirdly enough 3.4 too).
>

Yes, this part is indeed poorly implemented. But I don't think we can
remove the transition branch until we fix it, so I don't think we can take
this patch now.

perhaps we should maintain the overall documentation (for all versions) in
the same branch.. all these branches are making everything much
complicated.. Or perhaps we should split the documentation 'content' and
the documentation config and scripts. I am wondering how other projects are
doing it to support such complex doc setup (multiple versions to support
and to publish)!


>
> I assume we want this in all branches. Therefore I think we should move
> documentation/transition from that branch to master and copy the whole
> directory for each non-master branch (with the git checkout master trick
> from an earlier patch from Michael). I think this makes more sense than
> keeping a transition branch? Especially since I assume we want to move
> every 6 months one release from "Supported release manuals" to "Outdated
> releae manuals" ?
>

I think we had the 'transition' pages in master initially, and we moved
that to its own branch. I believe it's something we discussed with
Richard.. but i forgot the details.


>
> Cheers,
> Quentin
> > >
>

[-- Attachment #2: Type: text/html, Size: 4594 bytes --]