Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update hardware recommendations to include qubes-certified list #273

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

zenmonkeykstop
Copy link
Contributor

@zenmonkeykstop zenmonkeykstop commented Oct 25, 2024

Draft mode for now - it needs:

  • up-to-date sections on FPF-tested laptops, basically the most modern 3 testing laptops in use across the dev team.
  • A blurb about the Qubes HCL with pros and cons of it as a resource
  • Validation that we're ok with this approach to recommendations.

Fixes #211

Updates hardware reccos:

  • recommends qubes-certified, FPF-tested, and HCL options, in that order
  • moves config instructions for Thinkpad BIOS updates out of hardware reccos page, to make the point of the page clearer.

- reference qubes-certified, fpf-tested, and hcl
- move config instructions (BIOS) out of hardware reccos page, to make point of page clearer
.
@zenmonkeykstop zenmonkeykstop marked this pull request as draft October 25, 2024 21:16

- Follow the on-screen instructions to update the BIOS, including any mandatory reboots. Note that the instructions may refer to an update CD instead of your update USB.

USB-C ports
Copy link
Contributor

Choose a reason for hiding this comment

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

Was the decision to remove the section on USB-C ports because this information is no longer applicable, or because it's too in-the-weeds?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Bit of both - it references 8th-gen T480s so n/a, and if it is caused by bios settings in install section it can probably be a note there.

@@ -56,6 +56,7 @@ against malware and other security risks. It is built on Qubes OS and requires a
admin/reference/troubleshooting_updates
admin/reference/provisioning_usb
admin/reference/backup
admin/reference/thinkpad_bios
Copy link
Contributor

Choose a reason for hiding this comment

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

For the sake of consistency, we should probably either have a small guide for Framework BIOS updates as well, or at least link out to their knowledgebase article on the topic: https://knowledgebase.frame.work/framework-laptop-bios-releases-S1dMQt6F

Copy link
Contributor

Choose a reason for hiding this comment

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

Er, that link was for the 11th gen Intel board specifically. Looks like each product has its own BIOS update page. We'd either need to point to https://knowledgebase.frame.work/categories/products_en-r1aUmxtrd, or consider linking to each individual page in the aforementioned small guide.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My pref would be to link wherever possible - if that's an option I'd link from the section in the hardware reccos. Where there's a long or involved process that we have to document locally, I'd prefer to have it in a separate page.

@nathandyer
Copy link
Contributor

Thanks @zenmonkeykstop, even in early drafts this is looking really great. I think this is the correct approach, and I like the way you have explained everything. I left a couple small in-line comments just to jot down some thoughts.

I'm a bit iffy on whether or not it makes sense to include the note about Heads, but it is worthwhile for folks to know it's available, so it's probably reasonable to include it where you did.

Overall, I think this is a huge improvement! Would it be helpful if I tacked on a commit to fill some of the missing sections?

@zenmonkeykstop
Copy link
Contributor Author

Thanks @zenmonkeykstop, even in early drafts this is looking really great. I think this is the correct approach, and I like the way you have explained everything. I left a couple small in-line comments just to jot down some thoughts.

I'm a bit iffy on whether or not it makes sense to include the note about Heads, but it is worthwhile for folks to know it's available, so it's probably reasonable to include it where you did.

Yup that part in particular is worth debating. IMO it's worth mentioning because certified machines often have it as an option, but we could go either way.

Overall, I think this is a huge improvement! Would it be helpful if I tacked on a commit to fill some of the missing sections?

But of course!

@nathandyer
Copy link
Contributor

Thanks again! I just tacked on a commit which expands the Framework 13 section with a short explanation, and links out to the BIOS upgrade guide for the 13-gen CPUs. It also describes the Qubes HCL, and lists some of the benefits and downsides. I'm sure there are some that I missed, so we can add/remove to those as we see fit.

I also added a tiny commit that we can remove if we want to drop it, which just takes out the AMD processor recommendation since I know there has been some iffyness in how well they work in Qubes.

I left the X1 and T14 sections as-is for now; I think they're roughly still in an OK position, but we can tweak those as needed.

@eloquence
Copy link
Member

Draft looks good from my POV, left a couple comments.

@nathandyer
Copy link
Contributor

@zenmonkeykstop This can probably be flipped out of draft mode now, unless there are any other preliminary items you think we need to address first.

Copy link
Contributor

@deeplow deeplow left a comment

Choose a reason for hiding this comment

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

Took a look to the recent changes and the PR overall. The recommendations look sensible and I like the wording.

I have one suggestion, though. Historically there have been no links to the hardware products, it seems. However, for frameworks, since it's a lesser known brand and has a non-standard domain (frame[.]work) shall we add a no-referrer link at the very least tot he home page? (if that's a possibility with Read The Docs)

@nathandyer
Copy link
Contributor

@deeplow It's definitely possible to add a link like that with Sphinx/RST/RTD. Historically I believe we have intentionally avoided doing so, as to not recommend a particular source for purchase in hopes of diversifying where orgs are getting their hardware. It might be good to continue that precedent here (Frameworks are available directly from the manufacturer, but if there are any resellers or other vendors, it may be good for said diversity). But I have no strong feelings, and am happy to go whichever direction the team prefers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Phase out specific hardware recommendations
4 participants