Skip to content

Unify Workstation and Server hardware guide, and reduce complexity where possible#778

Open
nathandyer wants to merge 6 commits intomainfrom
unified-hardware
Open

Unify Workstation and Server hardware guide, and reduce complexity where possible#778
nathandyer wants to merge 6 commits intomainfrom
unified-hardware

Conversation

@nathandyer
Copy link
Contributor

Fixes #773

Test plan

  • Visual review
  • CI passes

Checklist

This change accounts for:

  • local preview of changes beyond typo-level edits

@nathandyer nathandyer moved this to Ready For Review in SecureDrop Mar 6, 2026
@ChumOfChance ChumOfChance self-requested a review March 6, 2026 15:42
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(missing from the Required Hardware section, not the list of required hardware in the opening Hardware Overview)

@ChumOfChance
Copy link
Contributor

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)

@ChumOfChance
Copy link
Contributor

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.

@nathandyer nathandyer moved this from Ready For Review to Under Review in SecureDrop Mar 10, 2026
@nathandyer
Copy link
Contributor Author

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)

I agree completely, and have just added a commit that does this. Please let me know what you think.

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'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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Under Review

Development

Successfully merging this pull request may close these issues.

Merge Workstation and Server hardware guides into one hardware guide

2 participants