#528 Review of older documents: Fedora on Raspberry Pi
Closed: complete 9 months ago by pboy. Opened a year ago by pboy.

We decided to start a Review of older Quick Docs articles:

  • Content: Is it technically up to date?
  • Quality: determine the type (how-to, tutorial, guide,...)
  • Usability: Add author (optional), related Fedora release, date of last substantial review/update

URL: https://docs.fedoraproject.org/en-US/quick-docs/raspberry-pi/

Specifically here

  • Should we integrate the partials into the main text body?
  • If not: move the partials into a Fedora Raspi article specific subdir of the partials directory to provide a better overview
  • Check all the Antora specific item. I gues, we don't have to use many of them anymore.

Metadata Update from @pboy:
- Issue tagged with: good first issue, improvement

a year ago

I want to suggest a light edit on this section "Installing Fedora on a Raspberry Pi using the Fedora ARM installer"

  • Source file:
    proc_installing-fedora-on-a-raspberry-pi-using-the-fedora-arm-installer.adoc

  • My edit: please find a text file. I find it super-hard to edit partials with attributes. I don't want to break the page. Could anyone interlace this text into partials? This installation guide is tried and tested with input from ARM expert on Discussion. I ran pi for 1 year as headless server.

  • Section to be replaced: Procedure on "Installing Fedora on a Raspberry Pi using the Fedora ARM installer"

rpi-adocreview.txt

Metadata Update from @hankuoffroad:
- Issue assigned to hankuoffroad

a year ago

On another note, why do we need other OS sections? Is there a need for that?
Unless there is a valid reason, we just need to keep installation for Fedora and other Linux.

Metadata Update from @hankuoffroad:
- Issue priority set to: next meeting (was: awaiting triage)

a year ago

We decided to move the partials back into the main text and then delete them. Exception: A partial is actually reused.

In the "other OS section" we describe how to install Fedora an on SBC if you have a Windows desktop, for example. Similarly, we also describe how to create an installation media for an edition under other OS. MediaWriter is even available in versions for MacOS and Windows. That seems to make sense to me.

Another question is how and who keeps the article up to date. There was a discussion by Ben and the ARM SIG about the article. ARM Sig maintains an article with (mostly) the same content in WIKI and is not happy with an outdated article in QD.

And another question is whether such an article, a complete installation guide, belongs in QD at all. I think not. Server Edition has its own installation guide for SBCs.

But ARM Sig wants to stay with WIKI, if I understand correctly. But with that they are currently not very visible.

What is established as is makes sense to SIGs, but not to me or potential users. I think server edition supports most universal use cases that we can document as standard installation. Forget wiki. R Pi can run Fedora server, IoT, CoreOS, Alma Linux and more. It is down to what standard minimum guide/documentation we can target.

Metadata Update from @hankuoffroad:
- Assignee reset

9 months ago

The article is updated now as of Aug. 08, 2023 with all reports I could identify. Please check and open an issue in case there is still something lacking of create a PR.

Metadata Update from @pboy:
- Issue close_status updated to: complete
- Issue status updated to: Closed (was: Open)

9 months ago

The article is updated now as of Aug. 08, 2023 with all reports I could identify. Please check and open an issue in case there is still something lacking of create a PR.

Please check this PR for review.

https://pagure.io/fedora-docs/quick-docs/pull-request/630

And another question is whether such an article, a complete installation guide, belongs in QD at all. I think not. Server Edition has its own installation guide for SBCs.

QuickDocs should contain edition-agnostic procedure on Fedora Linux, most of contributors can test. Edition-specific installation like Greenboot and FIDO in IoT is IoT's area.

Login to comment on this ticket.

Metadata
Attachments 1
Attached a year ago View Comment