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

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

[Michael Opdenacker]

No longer necessary now that the transition from DocBook to Sphinx is over

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
---
 scripts/run-docs-build | 6 ------
 1 file changed, 6 deletions(-)

diff --git a/scripts/run-docs-build b/scripts/run-docs-build
index 4451018..724d709 100755
--- a/scripts/run-docs-build
+++ b/scripts/run-docs-build
@@ -58,12 +58,6 @@ make clean
 make publish
 cp -r ./_build/final/* $outputdir
 
-cd $ypdocs
-git checkout transition
-make clean
-make publish
-cp -r ./_build/final/* $outputdir/
-
 cd $ypdocs
 git checkout master-next
 make clean
-- 
2.25.1

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

[Quentin Schulz]

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>

Thanks,
Quentin

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

[Nicolas Dechesne]

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

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://docs.yoctoproject.org/releases.html#outdated-release-manuals

Or am I missing here?


>
> Thanks,
> Quentin
>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#2215):
> https://lists.yoctoproject.org/g/docs/message/2215
> Mute This Topic: https://lists.yoctoproject.org/mt/87428499/1279857
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [
> nicolas.dechesne@linaro.org]
> -=-=-=-=-=-=-=-=-=-=-=-
>
>

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

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

[Quentin Schulz]

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).

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" ?

Cheers,
Quentin
> >

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

[Nicolas Dechesne]

[-- 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 --]

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

[Quentin Schulz]

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

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

[Michael Opdenacker]

Quentin, Nico,

On 12/3/21 11:51 AM, Quentin Schulz wrote:
>
> 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 :/


Thanks for your reviews. Good to know that the "transition" branch is
still in use in spite of what I wrongly believed.
It indeed, it's a good idea to see what other projects are doing. Maybe
what we are doing is unnecessarily complicated.

Look at Python docs (https://docs.python.org/) for example. They have a
switcher as we do, and also a left bar the latest versions and a
separate page for all versions. However, such versions are only shown on
the top page. When you enter one of the documents though for a given
version, the left bar is used for navigation between sections instead,
and you no longer have references to other versions.

Let's keep thinking about this, to find an easier to manage solution.
Thanks again
Michael.

-- 
Michael Opdenacker, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com

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

[Nicolas Dechesne]

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

On Wed, Dec 8, 2021 at 10:57 PM Michael Opdenacker <
michael.opdenacker@bootlin.com> wrote:

> Quentin, Nico,
>
> On 12/3/21 11:51 AM, Quentin Schulz wrote:
> >
> > 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 :/
>
>
> Thanks for your reviews. Good to know that the "transition" branch is
> still in use in spite of what I wrongly believed.
> It indeed, it's a good idea to see what other projects are doing. Maybe
> what we are doing is unnecessarily complicated.
>
> Look at Python docs (https://docs.python.org/) for example. They have a
> switcher as we do, and also a left bar the latest versions and a
> separate page for all versions. However, such versions are only shown on
> the top page. When you enter one of the documents though for a given
> version, the left bar is used for navigation between sections instead,
> and you no longer have references to other versions.
>

docs.pythong.org is where we stole the idea of the switcher ;-)
Would anyone be able to figure out if their 'publishing' script is
available anywhere? if we could mimic that somehow that might be good.


>
> Let's keep thinking about this, to find an easier to manage solution.
> Thanks again
> Michael.
>
> --
> Michael Opdenacker, Bootlin
> Embedded Linux and Kernel engineering
> https://bootlin.com
>
>

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

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

[Tim Orling]

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

On Wed, Dec 8, 2021 at 2:08 PM Nicolas Dechesne <nicolas.dechesne@linaro.org>
wrote:

>
>
> On Wed, Dec 8, 2021 at 10:57 PM Michael Opdenacker <
> michael.opdenacker@bootlin.com> wrote:
>
>> Quentin, Nico,
>>
>> On 12/3/21 11:51 AM, Quentin Schulz wrote:
>> >
>> > 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 :/
>>
>>
>> Thanks for your reviews. Good to know that the "transition" branch is
>> still in use in spite of what I wrongly believed.
>> It indeed, it's a good idea to see what other projects are doing. Maybe
>> what we are doing is unnecessarily complicated.
>>
>> Look at Python docs (https://docs.python.org/) for example. They have a
>> switcher as we do, and also a left bar the latest versions and a
>> separate page for all versions. However, such versions are only shown on
>> the top page. When you enter one of the documents though for a given
>> version, the left bar is used for navigation between sections instead,
>> and you no longer have references to other versions.
>>
>
> docs.pythong.org is where we stole the idea of the switcher ;-)
> Would anyone be able to figure out if their 'publishing' script is
> available anywhere? if we could mimic that somehow that might be good.
>

Maybe?
https://github.com/python/docsbuild-scripts/

Found on
https://pythondev.readthedocs.io/infra.html

>
>
>>
>> Let's keep thinking about this, to find an easier to manage solution.
>> Thanks again
>> Michael.
>>
>> --
>> Michael Opdenacker, Bootlin
>> Embedded Linux and Kernel engineering
>> https://bootlin.com
>>
>>
> -=-=-=-=-=-=-=-=-=-=-=-
> Links: You receive all messages sent to this group.
> View/Reply Online (#2237):
> https://lists.yoctoproject.org/g/docs/message/2237
> Mute This Topic: https://lists.yoctoproject.org/mt/87428499/924729
> Group Owner: docs+owner@lists.yoctoproject.org
> Unsubscribe: https://lists.yoctoproject.org/g/docs/unsub [
> ticotimo@gmail.com]
> -=-=-=-=-=-=-=-=-=-=-=-
>
>

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