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

Improve the Hardware Compatibility List (HCL) usability #1203

Closed
bnvk opened this Issue Sep 22, 2015 · 5 comments

Comments

Projects
None yet
4 participants
@bnvk

bnvk commented Sep 22, 2015

It's great to see that the HCL has been moved over to Github and .yml files, with this change it makes it much more possible to do nice usability things to improve it. Some ideas at shortly perusing it are:

  • Condensing items under "manufacturer" headings
  • Structuring the information to be slightly more pleasing / easier to read than a big ole
  • Making it searchable / filterable with list.js or dataTables
  • Offer tooltips for some of the details
@woju

This comment has been minimized.

Show comment
Hide comment
@woju

woju Sep 23, 2015

Member

On Tue, Sep 22, 2015 at 12:29:54PM -0700, Brennan Novak wrote:

It's great to see that the HCL has been moved over to Github and .yml files, with this change it makes it much more possible to do nice usability things to improve it. Some ideas at shortly perusing it are:

  • Condensing items under "manufacturer" headings
  • Structuring the information to be slightly more pleasing / easier to read than a big ole
  • Making it searchable / filterable with list.js or dataTables
  • Offer tooltips for some of the details
    • Fix colours. Really that should come first.

    I admit I chose these hastily, in hope someone will fix them soon, but
    that did not happen.

Member

woju commented Sep 23, 2015

On Tue, Sep 22, 2015 at 12:29:54PM -0700, Brennan Novak wrote:

It's great to see that the HCL has been moved over to Github and .yml files, with this change it makes it much more possible to do nice usability things to improve it. Some ideas at shortly perusing it are:

  • Condensing items under "manufacturer" headings
  • Structuring the information to be slightly more pleasing / easier to read than a big ole
  • Making it searchable / filterable with list.js or dataTables
  • Offer tooltips for some of the details
    • Fix colours. Really that should come first.

    I admit I chose these hastily, in hope someone will fix them soon, but
    that did not happen.

@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Sep 23, 2015

@woju thanks for the feedback, that will fall under #1207 which I'm working on as well!

bnvk commented Sep 23, 2015

@woju thanks for the feedback, that will fall under #1207 which I'm working on as well!

@marmarek marmarek added the C: doc label Oct 8, 2015

@marmarek marmarek added this to the Documentation/website milestone Jan 7, 2016

bnvk added a commit to bnvk/qubesos.github.io that referenced this issue Jan 14, 2016

bnvk added a commit to bnvk/qubesos.github.io that referenced this issue Jan 14, 2016

marmarek added a commit to QubesOS/qubesos.github.io that referenced this issue Jan 15, 2016

Merge remote-tracking branch 'origin/pr/21'
* origin/pr/21:
  minor tweaks to HCL page QubesOS/qubes-issues#1203
  Refactored HCL page to look nicer QubesOS/qubes-issues#1203
@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Jan 29, 2016

Member

@bnvk do you plan anything more in this ticket, or it is completed?
FWIW IMO HCL looks great.

Member

marmarek commented Jan 29, 2016

@bnvk do you plan anything more in this ticket, or it is completed?
FWIW IMO HCL looks great.

@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Jan 29, 2016

Member

I'd still like to discuss the name change, if possible (see the comments on this commit).

Member

andrewdavidwong commented Jan 29, 2016

I'd still like to discuss the name change, if possible (see the comments on this commit).

@bnvk

This comment has been minimized.

Show comment
Hide comment
@bnvk

bnvk Feb 17, 2016

@marmarek i'm closing this. I have other ideas incorporating "Certified laptops" into the page, but I will revisit it at that at a later time!

@axon-qubes if I understand correctly, the value to be gained changing back to "HCL" is appeasing people who have been reading / writing Qubes docs in the past as well as people reading through the Google Groups archives. My reasoning for changing from "Hardware Compatibility List" to "Compatible Hardware" is

  1. As you say "avoid confusing non-technical users" I think what I have better in this respect.
  2. It's shorter, thus easier to read / say / work into designs
  3. It's good to avoid acronyms in general, HCL is what said cause "hardware compatibility list" is cumbersome
  4. The URL is more SEO friendly

That said, i'm not going to block / nit pick about this. If you and others are really attached to "HCL" change it back!

start referring to it as the "the compatible hardware list" instead of "the HCL," and "the compatible hardware tool" instead of "the HCL tool,"

As per this question, I think when writing about this page / list, my instinct as a native English speaker would be to say list of compatible hardware or on the compatible hardware page

bnvk commented Feb 17, 2016

@marmarek i'm closing this. I have other ideas incorporating "Certified laptops" into the page, but I will revisit it at that at a later time!

@axon-qubes if I understand correctly, the value to be gained changing back to "HCL" is appeasing people who have been reading / writing Qubes docs in the past as well as people reading through the Google Groups archives. My reasoning for changing from "Hardware Compatibility List" to "Compatible Hardware" is

  1. As you say "avoid confusing non-technical users" I think what I have better in this respect.
  2. It's shorter, thus easier to read / say / work into designs
  3. It's good to avoid acronyms in general, HCL is what said cause "hardware compatibility list" is cumbersome
  4. The URL is more SEO friendly

That said, i'm not going to block / nit pick about this. If you and others are really attached to "HCL" change it back!

start referring to it as the "the compatible hardware list" instead of "the HCL," and "the compatible hardware tool" instead of "the HCL tool,"

As per this question, I think when writing about this page / list, my instinct as a native English speaker would be to say list of compatible hardware or on the compatible hardware page

@bnvk bnvk closed this Feb 17, 2016

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