documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Update documentation for differences between Bullseye and Buster

Open lurch opened this issue 2 years ago • 15 comments

We now offer both Bullseye and Buster (Legacy) releases of Raspberry Pi OS. However some features work in one but not the other, and vice-versa.

@JamesH65 has an internal document which is probably a useful starting point for this.

lurch avatar Dec 07 '21 15:12 lurch

And perhaps https://www.raspberrypi.com/documentation/computers/getting-started.html#installing-the-operating-system and/or https://www.raspberrypi.com/documentation/computers/os.html#introduction ought to mention the different versions too?

(edit by @aallan) Agreed. Needs to reference the different versions. The aim here is to try and focus the documentation though, not increase complexity. So overall the documentation needs to primarily support Bookworm, with mentions (NOTEs) pointing out that previous versions of the OS worked differently.

lurch avatar Dec 07 '21 15:12 lurch

I want to work on this issue so from where should i start

URRG avatar Dec 17 '21 17:12 URRG

This is already underway internally, but it's a private repo.

JamesH65 avatar Dec 17 '21 18:12 JamesH65

Sorry, closed by accident.

JamesH65 avatar Dec 17 '21 19:12 JamesH65

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Feb 20 '22 02:02 github-actions[bot]

This should stay open.

lurch avatar Feb 21 '22 10:02 lurch

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Apr 24 '22 02:04 github-actions[bot]

Should stay open. Still some updating needed. See also #2398.

aallan avatar Apr 24 '22 12:04 aallan

@aallan Are you simply updating the vlc and omx examples according to the version?

RuffaloLavoisier avatar Apr 24 '22 12:04 RuffaloLavoisier

@aallan Are you simply updating the vlc and omx examples according to the version?

OMX Player no longer works under Bullseye. All the examples using it in the documentation need to be replaced with an equivalent invocation for VLC (or other relevant software), see #2398 which is the linked issue.

However this issue is the more general "other things that Bullseye broke" issue. There are some other things beyond the OMX Player issue that haven't yet been fixed.

aallan avatar Apr 24 '22 12:04 aallan

If there is something to be done externally, I would be happy to contribute.

RuffaloLavoisier avatar Apr 24 '22 13:04 RuffaloLavoisier

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Jun 26 '22 02:06 github-actions[bot]

This still needs doing, at some point.

lurch avatar Jul 02 '22 19:07 lurch

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

github-actions[bot] avatar Sep 04 '22 03:09 github-actions[bot]

ping

JamesH65 avatar Sep 04 '22 08:09 JamesH65

There is still cruft from the Buster to Bullseye transition that will need clearing out (see above, e.g. video and audio players). However, we now need to look at the major transition to Bookworm.

This will involve several "big" things like the shift from X to Wayland, and from dhcpd to Network Manager. Those are going to have a major knock on wrt the documentation (see email for details).

I have created a bookworm branch for folks to work on.

One thing to be aware is some of the documentation will be going entirely, e.g. see #2687, and be moving off to the new tutorials site.

aallan avatar Apr 27 '23 10:04 aallan

Headline things:

  • X goes away and is replaced by Wayland
    • nominally a big thing, but there has been a lot of work to keep the user experience the same
    • but some change is inevitable
  • dhcpcd goes away and is replaced by Network Manager
    • Some of the dhcpd content needs moving to the tutorial pages, e.g. see #2687.
  • PulseAudio goes away and is replaced by PipeWire
    • The latter is supposed to be "API compatible", so hopefully nothing here breaks
  • Other random bookworm stuff
  • We should take this opportunity to move (or at least flag to move) other stuff to tutorials.

aallan avatar Apr 27 '23 10:04 aallan

Note: Documentation should be updated to reflect the latest version of the OS. So we're going to go through and make sure it all works with Bookworm. We may need some NOTE blocks that mention "for previous versions of Raspberry Pi OS" from time to time, but these need to be kept short (a couple of medium-length paragraphs at most). We do not have the availability to support multiple versions of the OS in the documentation going forward with breaking changes like Wayland and Network Manager happening.

aallan avatar Apr 27 '23 10:04 aallan

Child-issues:

  • #2999
  • #2947
  • #2948
  • #2949
  • #2950
  • #2951
  • #2952
  • #2953
  • #3053
  • #3075
  • #3090

lurch avatar Jul 04 '23 12:07 lurch

Done.

aallan avatar Sep 22 '23 19:09 aallan