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

From: Quentin Schulz <quentin.schulz@theobroma-systems.com>
To: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Cc: Michael Opdenacker <michael.opdenacker@bootlin.com>,
	yocto@lists.yoctoproject.org, docs@lists.yoctoproject.org
Subject: Re: [docs] [PATCH yocto-autobuilder-helper] scripts/run-docs-build: stop using the "transition" branch
Date: Fri, 3 Dec 2021 11:51:51 +0100	[thread overview]
Message-ID: <20211203105151.3hez2atqxq3ye63h@fedora> (raw)
In-Reply-To: <CAP71Wjxp04oP_YXX-em4OhRAvbjztATUEy9fozZ4+ves7NvVTw@mail.gmail.com>

On Fri, Dec 03, 2021 at 11:48:29AM +0100, Nicolas Dechesne wrote:
> 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://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_3.3_releases.html-23outdated-2Drelease-2Dmanuals&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=0ATdi4CSdy8VvhAKg6W6Qe5J7HEmGOLkDTVb13pe2bQyCiXzZxZGI_ePuUigui73&s=sW9qt9Z46xCwvoaxsU7RvUYqfKmOlSN8T_vDv0Yc_qE&e= 
> > does not exist, but
> > https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.yoctoproject.org_releases.html-23outdated-2Drelease-2Dmanuals&d=DwIFaQ&c=_sEr5x9kUWhuk4_nFwjJtA&r=LYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m=0ATdi4CSdy8VvhAKg6W6Qe5J7HEmGOLkDTVb13pe2bQyCiXzZxZGI_ePuUigui73&s=vI9nhu-xEodig5uSD7RDYKswiZHG_8PDgnd2No0oXMA&e= 
> > 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.
> 

Agreed, I poorly reviewed it. Thanks for stoping us before the disaster
:)

> 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 think all our issues always come down to this weird and inefficient
organization we have for docs and common files between doc releases.
We'll need to settle on something one day because I don't think what
we're doing today is working :/

Cheers,
Quentin