[RFC] Translating "Hands-on Kernel Lab" to Sphinx; updating

[RFC] Translating "Hands-on Kernel Lab" to Sphinx; updating

[Tim Orling]

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

In preparation for the Yocto Summit, I have begun translating the legacy
"Hands-on Kernel Lab" to Sphinx/ReStructuredText.

My WIP branch is
https://github.com/moto-timo/yocto-docs/tree/timo/kernel-lab

I will be updating/rebasing multiple times in the coming days. Do not
expect this repository to completely stabilize until the day of the Yocto
Summit.

I would very much appreciate eye-balls on this branch and the corresponding
content based on the 2.6 version [1][2] as well as some unpublished updates
for 3.3 [3].

My proposal is to add the metadata layers as git submodules to an overall
layer. Ideally this would be hosted at git.yoctoproject.org. This would
allow the content to be updated via typical git/mailing list processes,
rather than an awkward tarball => website workflow. I will lay out this
structure on GitHub as a proposal. Do not expect the corresponding
layers/repos to be stable as they will be in extreme flux up until the day
of the Yocto Summit. If you have other ideas for how to
develop/maintain/share this content, please speak up.

NOTE: my initial focus is simply on translating to Sphinx and updating to
the current Yocto Project release and Linux kernel(s). I will entertain
other changes once these required steps are complete.

Let the discussion begin!

--Tim

[1] https://wiki.yoctoproject.org/wiki/images/4/42/Kernel-lab-2.6.pdf
[2]
https://github.com/moto-timo/yocto-kernel-lab-layers/blob/legacy-2.6/kernel-lab-2.6-layers.tar.bz2
[3]
https://github.com/moto-timo/yocto-kernel-lab-layers/blob/interim-3.3/kernel-lab-3.3-layers.zip

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

Re: [docs] [RFC] Translating "Hands-on Kernel Lab" to Sphinx; updating

[Tim Orling]

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

On Wed, Nov 10, 2021 at 1:01 AM Michael Opdenacker <
michael.opdenacker@bootlin.com> wrote:

> Hi Tim,
>
> On 11/10/21 6:45 AM, Tim Orling wrote:
> > In preparation for the Yocto Summit, I have begun translating the
> > legacy "Hands-on Kernel Lab" to Sphinx/ReStructuredText.
> >
> > My WIP branch
> > is https://github.com/moto-timo/yocto-docs/tree/timo/kernel-lab
> > <https://github.com/moto-timo/yocto-docs/tree/timo/kernel-lab>
> >
> > I will be updating/rebasing multiple times in the coming days. Do not
> > expect this repository to completely stabilize until the day of the
> > Yocto Summit.
> >
> > I would very much appreciate eye-balls on this branch and the
> > corresponding content based on the 2.6 version [1][2] as well as some
> > unpublished updates for 3.3 [3].
> >
> > My proposal is to add the metadata layers as git submodules to an
> > overall layer. Ideally this would be hosted at git.yoctoproject.org
> > <http://git.yoctoproject.org>. This would allow the content to be
> > updated via typical git/mailing list processes, rather than an awkward
> > tarball => website workflow. I will lay out this structure on GitHub
> > as a proposal. Do not expect the corresponding layers/repos to be
> > stable as they will be in extreme flux up until the day of the Yocto
> > Summit. If you have other ideas for how to develop/maintain/share this
> > content, please speak up.
> >
> > NOTE: my initial focus is simply on translating to Sphinx and updating
> > to the current Yocto Project release and Linux kernel(s). I will
> > entertain other changes once these required steps are complete.
> >
> > Let the discussion begin!
>
>
> Thanks for starting this.
> Is the plan to eventually add such labs to the main documentation?


Yes. I added a new “Hands-on Manuals” section to the navbar.

The collateral metadata will need a different home however.

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

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

Re: [docs] [RFC] Translating "Hands-on Kernel Lab" to Sphinx; updating

[Tim Orling]

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

On Mon, Dec 13, 2021 at 8:09 AM Michael Opdenacker <
michael.opdenacker@bootlin.com> wrote:

> Hi Tim
>
> On 11/10/21 3:12 PM, Richard Purdie wrote:
> > On Wed, 2021-11-10 at 06:09 -0800, Tim Orling wrote:
> >>
> >> On Wed, Nov 10, 2021 at 1:01 AM Michael Opdenacker
> >> <michael.opdenacker@bootlin.com> wrote:
> >>> Hi Tim,
> >>>
> >>> On 11/10/21 6:45 AM, Tim Orling wrote:
> >>>> In preparation for the Yocto Summit, I have begun translating the
> >>>> legacy "Hands-on Kernel Lab" to Sphinx/ReStructuredText.
> >>>>
> >>>> My WIP branch
> >>>> is https://github.com/moto-timo/yocto-docs/tree/timo/kernel-lab
> >>>> <https://github.com/moto-timo/yocto-docs/tree/timo/kernel-lab>
> >>>>
> >>>> I will be updating/rebasing multiple times in the coming days. Do not
> >>>> expect this repository to completely stabilize until the day of the
> >>>> Yocto Summit.
> >>>>
> >>>> I would very much appreciate eye-balls on this branch and the
> >>>> corresponding content based on the 2.6 version [1][2] as well as some
> >>>> unpublished updates for 3.3 [3].
> >>>>
> >>>> My proposal is to add the metadata layers as git submodules to an
> >>>> overall layer. Ideally this would be hosted at git.yoctoproject.org
> >>>> <http://git.yoctoproject.org>. This would allow the content to be
> >>>> updated via typical git/mailing list processes, rather than an awkward
> >>>> tarball => website workflow. I will lay out this structure on GitHub
> >>>> as a proposal. Do not expect the corresponding layers/repos to be
> >>>> stable as they will be in extreme flux up until the day of the Yocto
> >>>> Summit. If you have other ideas for how to develop/maintain/share this
> >>>> content, please speak up.
> >>>>
> >>>> NOTE: my initial focus is simply on translating to Sphinx and updating
> >>>> to the current Yocto Project release and Linux kernel(s). I will
> >>>> entertain other changes once these required steps are complete.
> >>>>
> >>>> Let the discussion begin!
> >>>
> >>> Thanks for starting this.
> >>> Is the plan to eventually add such labs to the main documentation?
> >>>
> >>
> >> Yes. I added a new “Hands-on Manuals” section to the navbar.
> >>
> >> The collateral metadata will need a different home however.
> >>
> > Repositories on git.yoctoproject.org are available! :)
> >
> > Cheers,
> >
> > Richard
>
> Do you plan to submit a patch for inclusion in the main documentation,
> now that you ran your lab?
>
Yes. But what i submit will be the qemux86 workflow of the original lab,
not the qemuarm64 workflow of the hands on Yocto Summit 2021.11 lab.


> When you have time, of course...
>
That is the issue right now. Lab 3 and 4 need a bit more work. Power outage
over the weekend took out my internet gateway and I just switched
employers. "Soon".


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

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