Add topics for OpenSSH #181
No reviewers
Labels
No labels
in progress
in progress
meeting
need info
ongoing work project
on hold
pending activity
release test
user documentation
No milestone
No project
2 participants
eseyman
Notifications
Due date
No due date set.
Dependencies
No dependencies set.
Reference
server/user-documentation!181
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "goroboro/user-documentation:OpenSSH"
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?
These topics are effectively a migration of content from:
https://forge.fedoraproject.org/docs-archive/sysadmin-guide/src/branch/main/modules/system-administrators-guide/pages/infrastructure-services/OpenSSH.adoc
The intention here is to create Server Administration documentation about OpenSSH. In this pass, the original topic is migrated and chunked into 4 topics that can be separated out if needed. The content remains largely faithful to the original text, but I have inserted some comment blocks as placeholders for additional content that I intend to add at a future date. The following key differences apply to the original topic:
Other than these changes, I haven't changed text or performed extensive validation, beyond an initial check that the commands all look roughly sane, given my experience.
I intend to do significant rework on this content in a separate set of PRs. But wanted to get a base accepted, so that changes can be more atomic and clear. I appreciate that this is a big PR because of the migration, but hopefully, given that most of this content was pre-existing, and it is under active review and rework, this approval can make its way into the Server docs without too much controversy.
Thanks in advance for your review and your time.
WIP: Add topics for OpenSSHto Add topics for OpenSSHI'm wondering if it is useful, to create a branch, e.g. sshd-new, and pull it therein. So we can more easily discuss the text. And later merge the branch. I'm a bit hesitant, to make it publicly available at the first shot.
I am withdrawing the proposal. The text can be read just as easily in the forged repository as it can on the main branch.
I think we can publish the articles as they are. Perhaps the first text (about) doesn’t really belong in the server documentation. But we don’t have anywhere else to put it at the moment. So I’m in favour of including it as well. Dividing it into four parts makes it easy to change the location once Docs has progressed further than it has now.
@pboy wrote in #181 (comment):
Thanks @pboy.
On the whole, the content is not a long way from what was originally in the system administrators guide. Obviously, it would be good to have some review, but once this is published, it will be way easier to track small changes as independent PRs.
The four parts was intentional for precisely the reason you mentioned, but I am also a fan of small guides that contain everything I need to know about topic X. So I would personally prefer for the content to all stay together, wherever it ends up. That way, someone looking at how to do something on server, doesn't need to know to have to look in another location to find more conceptual info, or somewhere else to find out about the client, etc. But I also understand that it can be hard to decide on delineation sometimes. As you say, the location can change later, because the content separation is already there in the doc.
Let me know if there is anything else I can do to help move this forward. Once published, I will work on additions and improvements to this doc. Each in a much smaller PR.