Software-Management #969
No reviewers
Labels
No labels
content
maintenace & QA
content
needs review
content
needs update
content
new
project
category system review
project
kernel&boot
project
multimedia
project
restructure Quick Docs
project
tag collection review
effort
high
effort
low
effort
medium
good first issue
help wanted
meeting topic
needs changes
needs reporter feedback
needs review
priority
high
priority
low
priority
medium
priority
on hold
type/content
type/misc
No milestone
No project
No assignees
4 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
docs/quick-docs!969
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "goroboro/quick-docs:Software-Management"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
This PR significantly overhauls the "Adding and managing software" section of Fedora Quick Docs, bringing it up to date for currently supported releases (Fedora 41 and newer, using DNF5) and restructuring the navigation for clarity.
Navigation restructure
The section is reorganised into three clear areas: core package management topics, a third-party software subsection, and a new "Installing popular applications" group. Topics covering specific applications (VLC, Spotify, Zoom, Chromium, Java, fonts, desktop environments) are grouped separately from package management mechanics. openh264.adoc is retired and its content is merged into the multimedia plugins page. Also, I separated out legal content and put that under the FAQ section and did away with the remaining content in packagekit-not-found.adoc because this was consolidated into some newer topics described below.
New topics
I added several new topics:
Managing software on immutable Fedora editions: rpm-ostree layering, Flatpak as the preferred app delivery method, and Toolbox for development environmentsUpdated topics
Style and consistency pass
All topics in the section were run through the Red Hat Vale linter. Changes include: contractions expanded, passive voice reduced, heading capitalisation normalised (sentence case for H2+), code blocks annotated with [source,bash,console] and
/sudo prompts, e.g./i.e. replaced with for example/that is, and Fedora-specific vocabulary added to the Vale exceptions file.Screenshots
All screenshots in finding-and-installing-linux-applications.adoc are retaken on Fedora 42 (GNOME 50 and Plasma 6), replacing images from the older Fedora releases.
@ -15,6 +15,8 @@ DNF makes it easy to maintain packages by automatically checking for dependencieThis method eliminates the need to manually install or update the package, and its dependencies, using the `rpm` command.DNF is now the default software package management tool in Fedora.NOTE: DNF applies to standard Fedora editions. On immutable editions such as Silverblue, Kinoite, and Sway Atomic, the base system is read-only and package management works differently. See xref:software-management-immutable.adoc[Managing software on immutable Fedora editions].We prefer to call these systems image based (or image-based) rather than immutable. Also, the only image based Fedora edition currently is CoreOS. All Atomic Desktops, and also bootc images are better described as image based variants.
Thanks for this feedback. I have gone through all of my mentions and updated. Hopefully the latest commit fixes this.
@ -0,0 +30,4 @@Flatpak is the recommended way to install desktop applications on immutable Fedora editions.Flatpak applications run in a sandboxed environment and do not require changes to the base system image, so no reboot is needed after installation.Fedora's immutable editions ship with Flatpak support and the Flathub repository configured by default.The Flathub repository is not configured (or more precisely – enabled) by default on Atomic Desktops systems yet, but this will likely change for the F45 release. BTW, we should rework this and the whole Flatpak section in our docs.
I have changed this to include a statement that you need to enable the Flathub repo. Hopefully that makes sense. I don't have atomic system running to test this right now.
As a side note, submitting such a huge amount of changes and commits in a single PR makes it very hard to review, at least for me.
@ -0,0 +132,4 @@$ rpm-ostree install distrobox----== Additional resourcesI would recommend adding a reference to the Fedora Atomic Desktops User Guide.
Additionally, rewording immutable and editions throughout will align this page with the Atomic Desktops docs.
Also, for the AsciiDoc styling I would suggest placing every sentence on its own line and properly formatting the source code blocks (in this case console commands) for easier and more accurate copying and pasting.
I think I have done this accurately. Let me know if there is anything that you see missing.
Most of the content in this section of the repo didn't have the 'console' class set on any of the codeblocks. I tried to add them. Hopefully I have done this correctly.
@hricky wrote in #969 (comment):
That's fair but it was a fairly hefty restructure and as I worked there were an increasing number of gaps and fixes that needed to happen. I did apologize for the scale of this in the docs Matrix channel. In future, I will try to submit smaller PRs.
@goroboro wrote in #969 (comment):
When we write docs for image based systems, we always test what we document.
I'm not entirely sure we even need a software management page for image based systems in Quick Docs. The way this page is currently written simply repeats what's already explained in the Atomic Desktops and CoreOS docs and still needs corrections. I think if we want to mention package management for image based systems in the DNF and other pages, we can just refer to the relevant docs.
@hricky wrote in #969 (comment):
Okay, but I think this is true of most of the quick-docs. We could just say, this stuff repeats what is in the docs, or needs to go into the docs. Since the quick-docs has sections that describe how to do things with DNF, the omission of any mention of the atomic desktops and the fact that software management is different is confusing and misleading. I aimed to make this a bit more comprehensive and balanced.
I will spin up a VM with at least one atomic desktop to step through this.
It would help if you just let me know what corrections need to be made or what is inaccurate.
If it makes sense to drop this, then I am happy to do so, but then I would argue to drop probably around 60% of the content in quick-docs.
I can't speak for Quick Docs as a whole because I haven't read every single page. As I said:
These docs are maintained by the appropriate teams and we strive to keep them up-to-date and understandable for all types of readers. If we are going to add a special page in Quick Docs related to image-based systems, I think the right way is to first open an issue to discuss if adding such a page is appropriate. If we decide it is, then I can assist with writing and maintaining it.
Linking to authoritative content and deduplication are really important.
To note, @hricky is a leader in the Atomic distro space, so his words here carry a lot of weight.
I definitely didn't intend anyone to think that I was disregarding what @hricky was suggesting here. I was just trying to ensure that if the quick-docs were providing details on software management, they weren't completely ignoring the fact that this works differently depending on what flavour of Fedora you're using.
I agree that deduplication is important, but the quick-docs do tend to duplicate information anyway. I am just trying to make what currently exists, a bit more accurate, structured, and up to date. If deduplication should be the focus, a lot of this content should just be scrapped.
For what its worth, I have removed the atomic topic entirely, and instead made sure that the dnf topic and the package-management topics point directly to the Atomic Desktop User's Guide. Hopefully that addresses the primary concern here.
Happy to explore other dedup work if that is necessary.
I think Petr's thumbs up means dedup work is good, and linking to the Atomic info is good.
A big picture assesment of docs and quick docs is certainly going to be useful, lets talk about it in the Matrix channel or at a meeting soon.
I see you had a look at #923
Question to team - who will review and approve this epic commit?
@theprogram wrote in #969 (comment):
Yeah, I mean, Quick Docs is a sort of a catch-all for anything that doesn't belong elsewhere. When there's a SIG actively maintaining their docs, like with Atomic, it's better to keep the docs there.
I'll do a review soon.
Alright, this has been open for a while and early feedback has been incorporated. I didn't look too deep but I think we can merge this.
Thanks for the PR @goroboro, but let's keep them smaller next time :)