Unify Workstation and Server hardware guide, and reduce complexity where possible#778
Unify Workstation and Server hardware guide, and reduce complexity where possible#778nathandyer wants to merge 6 commits intomainfrom
Conversation
docs/admin/installation/hardware.rst
Outdated
There was a problem hiding this comment.
The Network Firewall is a required piece of hardware, but it only appears near the end of the page, under the Specific Recommendations (it's missing from the earlier list of Required Hardware). See the comment I am about to add about a more general reorganization though.
There was a problem hiding this comment.
(missing from the Required Hardware section, not the list of required hardware in the opening Hardware Overview)
|
I think there could be some more consolidation and reorganization of this installation/hardware page. Right now there is a Hardware Overview that lists in brief the required hardware and optional hardware in two lists. Then there is are Required Hardware and Optional Hardware sections which go into detail about the general requirements for each piece of hardware. Then there is a list of Specific Recommendations for laptops and servers, USB export devices, and Network Firewalls. The most specific recommendations for printers are actually already in the previous section. I propose we consolidate the Specific Recommendations into the earlier section. If I am trying to select a server, I should not have to check two different sections of the same document (first general requirements for server hardware, then the later specific recommendations of different server models). It should all be in the same section. Some additional info could be cut for brevity (e.g. the older EOL NUCs can be grouped together, or combined into a table) |
|
Another suggestion would be to move the server hardware modifications to their own page or appendix. It's a lot of info and pictures to scroll through, but any part of it is only relevant to a small minority of readers. |
I agree completely, and have just added a commit that does this. Please let me know what you think.
I'm slightly on the fence about this, especially now that the overall guide is quite a bit shorter. It certainly could go into a separate document, and I'm open to it, but it feels like the core hardware guide is where this belongs, and I hesitate to stretch the hardware guide out into multiple pages (even if the pages themselves are shorter, it feels like expanding more than reducing here) |
Fixes #773
Test plan
Checklist
This change accounts for: