Revision of the Fedora Server documentation #261
Labels
No labels
Ansible
basic support
Ansible
NFS server
Ansible/pxe
Ansible/Wildfly
distribution
bug
distribution
release test
distribution
rfe
documentation
improvement
documentation
new
documentation
review request
documentation
update required
meeting
need info
project
backup&restore
project
home server spin-off
project
LocalKDC
project
strengthening updates
status
in progress
status
on hold
status
pending activity
Working Group Organization
No milestone
No project
No assignees
5 participants
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
server/tickets#261
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
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 ticket provides a summary of various detailed tickets.
Summary of the state of the discussion as at 19 August 2026
We have at least 4 topics / Types of issues to discuss.
New structure for postinstall
Ticket #228
Already agreed:
Still to decide:
New structure for navigation bar
Ticket #224
Already done:
Still to decide:
linter / vale support
Ticket #234
Ticket #233
No discussion started yet
style issues
Ticket #234
Ticket #233
Ticket #217
No discussion started yet
Another item on postinstall: I merged a recent PR to create boolean values to enable/disable tasks in the role (server/ansible-support#183). I now believe that the boolean variable names should use underscores rather than dashes, as this is more conventional. I might be wrong about this though.
--- Apologies... I noticed that this content item is not about the ansible. So you can probably ignore this comment, unless the ansible gets discussed :)
@goroboro wrote in #261 (comment):
You are right, they should be underscores! 🙂
I'm working on this.
=== Result as of meeting September 02, 2026
On our September 02, 2026 meeting we couldn't agree about the naming of the detail-articles for the new postinstallation section and to start a voting.
The Discussion / Consideration was along
The Alternatives are
Please, vote 6 times, something like
EXAMPLE:
1 a
2 b
3 -
4 -
5 b
6 a
The voting starts now and is - according to our governance rules - running for 2 weeks.
So it will end: Friday September 18, 2026, 23:59 UTC
We can elaborate in each section as to what is covered in each section, but alternative B provides a good top level overview of what to expect.
My vote now:
1 a
2 a
3 a
4 a
5 a
6 a
My vote, with consideration that this content is for a set of subsections beneath Postinstallation Customizations which already describes the purpose of these sections:
1 b
2 b
3 b
4 b
5 b - Maybe 'Software Updates'
6 b
I think these naming decisions are being made prematurely, because I believe these names will emerge naturally as the content takes shape and we understand the story we're trying to tell. As of now, that story is still very much up in the air, and by adopting these names now, we constrain where the content can live and how it can be presented.
I've been thinking about this document as a whole almost every day for the past couple of months, and I have so many ideas for it. I also have many questions that I don't think I have a good answer to.
What kind of document is this? Is it a guide? A reference manual? A tutorial? Also, who is this for? Who do we want to read this?
Names like "Storage", "Networking", "Security", etc. all imply top-level headers and don't belong in the Post-installation section. The whole point of the Post-installation section is that there are certain decisions that every system administrator must make that can't be made for them. These steps could have been in Installation but the Installation environment is limited and ephemeral, so you do it after Installation instead.
"Automatic Updates" could just be set up by default, but that trades away some amount of stability and control. Every administrator will deal with DNF. Some administrators will also deal with Flatpak and podman containers, and that's a choice they will make, but this choice happens at different times. If this is a reference manual, the "Automatic Updates" page might document all the knobs for automatic update system-wide, but if this is a guide, it makes no sense to talk about registry updates when you haven't even introduced containers yet.
I think the "Security" section that would live in Postinstallation would more appropriately be called "System Hardening". Far from discussing all possible security considerations, it's a few basic hardening measures that every admin should do that can't be done without some decisions being made. A page called "Security" is more likely a high-level overview of what security features Fedora Server has, like SELinux, stack smashing protection, whatever. Security is a cross-cutting concern like logging and metrics that will appear everywhere and affect everything. We will need to talk about security in many different places.
If we had a page called "Networking", it should live at the top-level and have pages that talk abou how to set up, I dunno, IPsec or VLAN or bridge networking or whatever. If it appears under "Postinstallation", it should probably be "Basic Networking" and breeze through setting up your hostname, Ethernet or Wi-Fi. Any more than that is way out of scope.
But even that, I don't think is granular enough. I thought the pages here would be called "Set up a hostname", "Set up Ethernet networking", "Disallow root login", "Configure firewall", exactly what the things are, and express a simple intent, because "Postinstallation" is inherently a start-to-finish tutorial/guide, and should be hyper-focused on these early setup tasks.
I also think we need to choose shorter names for things across the board. Who is our audience? It's definitely not seasoned Linux admins who know this stuff backwards and forwards. Why would they even bother to look at our docs when they can read the man page for firewall-cmd? Or just read the kernel source?
The audience that I am writing for is people who are new to server administration, and are looking for an easy, flexible and understandable way to serve applications for themselves, their community, or their small businesses. This is NOT a career admin. This is someone who has no idea what any of this is and is relying on us to lead them down a path to success. That means smaller words, concise explanations, shorter sections, and assurance that they're on the right track. If I'm not writing to that audience, then I can't serve the audience that I'm here to serve.
My vote is that we need to spend a lot more time thinking about what we want this document to be before we start making permanent naming decisions. As presented, I'm not sure how to respond.
@brettweir very good ideas and considerations!
A summary of our discussion at meeting Sep 09, 2026:
Topic 5: Server Documentation Revision
Action items: