From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from aws-us-west-2-korg-lkml-1.web.codeaurora.org (localhost.localdomain [127.0.0.1]) by smtp.lore.kernel.org (Postfix) with ESMTP id 72B1FC433F5 for ; Fri, 3 Dec 2021 10:48:47 +0000 (UTC) Received: from mail-ed1-f46.google.com (mail-ed1-f46.google.com [209.85.208.46]) by mx.groups.io with SMTP id smtpd.web08.10183.1638528522344474850 for ; Fri, 03 Dec 2021 02:48:42 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@linaro.org header.s=google header.b=YFmAK+PJ; spf=pass (domain: linaro.org, ip: 209.85.208.46, mailfrom: nicolas.dechesne@linaro.org) Received: by mail-ed1-f46.google.com with SMTP id e3so9825028edu.4 for ; Fri, 03 Dec 2021 02:48:42 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=mime-version:references:in-reply-to:from:date:message-id:subject:to :cc; bh=QA/3XGUi2zF5i6NX+QBtztTLTYco3WMsNzcNjUiizQE=; b=YFmAK+PJGDN86ZRflZyLpdmkeWvOw+PkzbVoEIOS1P4E4E5bsjxVvv1fuFbR4fSIrd Iq+DrFsw5tplq5jWBa7Wky97zOpF5H/X56Gq+h8K6i887pi/aitnYLFmEv7DlttqyscG 2smiYYJSHLsoKk6GT3Kxu9f+uE6kYi+jvrJoudIBNIuRe+peJcXuveFug859onsVlJ2T YNKdd4j1A6e5y9em5hrxxMTyq7aWENn71BEaJM6NrE/Gj9Zm9K5eDbEwKACNGrmSlLml iAMULaFwg3BhNzMVpCT1k5ESX2DoNpAzsW2tYjDBvspp8AvaMiC9u0fP623ftDeizElv lR3g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:mime-version:references:in-reply-to:from:date :message-id:subject:to:cc; bh=QA/3XGUi2zF5i6NX+QBtztTLTYco3WMsNzcNjUiizQE=; b=AVpFRJoof1rYyYaPGbpnMjT8wtBB5dHkCt9vCiVI3P94XqpJoIQDIbrqR1M16W299G MLdfWyRPjrKmOKhSUzwRXQEdw0/yCcdYvUlyCymrWMxbHTe40c3IcHo/o+6jlv4wFWcN 9INQGWUifzljmTuckYiS1MP5VmMKWzf8sTaiWq45cWas0EwwzekybbBFMi3FgtUN3WnO 0wHc8YmmsTn9VBPG+Vgg3myP1IaXQd+PoCsgWRUbnv1xRrHSlPSVGN/czGQw/WTsvK1O cin1skQJAEQ8AtNKN/6ArT6ZfAgRQRmAxUZfxMyqmt7O2E6wE6THZAQcwmomWkMEXscE fvRw== X-Gm-Message-State: AOAM531gSUfyP1hytqITH8/pXvEyuIfG5gXaedv49y5g+vXvwKh+Sp8Y 3EiAmEwZpyLk6yI2+xx0IAFeS+BkUDiyWe9VAY2vYg== X-Google-Smtp-Source: ABdhPJwrN0tmMF6whvMensH/Itw6v71TcrebUuOcJv/dlfF/NG6EpLfd9Nque+qBGLXVKK95OhOhEyp5Ytxw9iNmloY= X-Received: by 2002:a05:6402:12c1:: with SMTP id k1mr25403260edx.355.1638528520296; Fri, 03 Dec 2021 02:48:40 -0800 (PST) MIME-Version: 1.0 References: <20211201135949.193842-1-michael.opdenacker@bootlin.com> <20211203093452.sk3e6ksnwmsbnjn2@fedora> <20211203100259.54n7h7ghlqfr5tia@fedora> In-Reply-To: <20211203100259.54n7h7ghlqfr5tia@fedora> From: Nicolas Dechesne Date: Fri, 3 Dec 2021 11:48:29 +0100 Message-ID: Subject: Re: [docs] [PATCH yocto-autobuilder-helper] scripts/run-docs-build: stop using the "transition" branch To: Quentin Schulz Cc: Michael Opdenacker , yocto@lists.yoctoproject.org, docs@lists.yoctoproject.org Content-Type: multipart/alternative; boundary="00000000000068351c05d23ba6bc" List-Id: X-Webhook-Received: from li982-79.members.linode.com [45.33.32.79] by aws-us-west-2-korg-lkml-1.web.codeaurora.org with HTTPS for ; Fri, 03 Dec 2021 10:48:47 -0000 X-Groupsio-URL: https://lists.yoctoproject.org/g/yocto/message/55471 --00000000000068351c05d23ba6bc Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable 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 > > > > > > Reviewed-by: Quentin Schulz > > > > > > > I don't understand. With this change, we no longer build the pages we > > reference here: > > > https://urldefense.proofpoint.com/v2/url?u=3Dhttps-3A__docs.yoctoproject.= org_releases.html-23outdated-2Drelease-2Dmanuals&d=3DDwIBaQ&c=3D_sEr5x9kUWh= uk4_nFwjJtA&r=3DLYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172= IIy1t&m=3DnyCl21erajBNcx6SkCKI_BEntNgbh6114vcdWp_vB5yDzorVFjmzdqp0WXIIpQyK&= s=3Drw5wG0nk_9KQ8RLvE1-sbSicy4NslWaeMwoyTSUuIyY&e=3D > > > > 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 > > > > --00000000000068351c05d23ba6bc Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable


=
On Fri, Dec 3, 2021 at 11:03 AM Quent= in Schulz <quent= in.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 wrot= e:
> > > No longer necessary now that the transition from DocBook to = Sphinx is
> > over
> > >
> > > Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.co= m>
> >
> > 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.pr= oofpoint.com/v2/url?u=3Dhttps-3A__docs.yoctoproject.org_releases.html-23out= dated-2Drelease-2Dmanuals&d=3DDwIBaQ&c=3D_sEr5x9kUWhuk4_nFwjJtA&= ;r=3DLYjLexDn7rXIzVmkNPvw5ymA1XTSqHGq8yBP6m6qZZ4njZguQhZhkI_-172IIy1t&m= =3DnyCl21erajBNcx6SkCKI_BEntNgbh6114vcdWp_vB5yDzorVFjmzdqp0WXIIpQyK&s= =3Drw5wG0nk_9KQ8RLvE1-sbSicy4NslWaeMwoyTSUuIyY&e=3D
>
> 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.or= g/3.3/releases.html#outdated-release-manuals
does not exist, but
https://docs.yoctoproject.org/re= leases.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 remov= e the transition branch until we fix it, so I don't think we can take t= his patch now.=C2=A0

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

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 &q= uot;Outdated
releae manuals" ?

I think we had t= he '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.=C2=A0
=C2=A0

Cheers,
Quentin
> >
--00000000000068351c05d23ba6bc--