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

Present criteria as not-tables #113

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

funnelfiasco
Copy link
Contributor

@funnelfiasco funnelfiasco commented Dec 17, 2024

This improves small-screen readability and removes/moves extraneous information for easier skimming.

Some choices I made:

  • I went with just the ID and criterion because the level is in the heading and the category is in the ID. I added them to the detailed view for completeness sake.
  • I could have iterated over the three levels instead of copy pasta, but
    1. The more code blocks we add, the more complicated the template gets
    2. I think we'll eventually want to add a brief description of each level before we start listing the criteria, so this is future-proofing against that a bit
  • Edit to add the other thing I was going to put here: this approach requires no muddling with CSS, adding plugins, etc and still achieves the overarching goal

Preview available as https://funnelfiasco.github.io/security-baseline/

Fixes #99

@eddie-knight
Copy link
Contributor

Thanks for making this happen, I think this is the right approach.

Something feels just a bit off with the list, but I can't put my finger on it. Perhaps it's the lack of a leading list mark on each line, or the use of an emdash 🤔 Just feels like it's almost there, but not quite.

@funnelfiasco
Copy link
Contributor Author

Perhaps it's the lack of a leading list mark on each line, or the use of an emdash

I considered putting them in an unordered list but I thought that would make it worse in terms of padding between entries. We could certainly solve that with CSS, but I don't think a list is quite the right approach. I do love emdashes, but we could potentially remove them here, or replace them with a colon.

What about bolding the ID so that it stands out a little better?

  • OSPS-AC-01 The project’s version control system MUST require multi-factor authentication for collaborators modifying the project repository settings or accessing sensitive data.

@jordansissel
Copy link

This is much improved when I try to read this version compared to the table (especially on mobile)

cmd/template.md Outdated Show resolved Hide resolved
@david-a-wheeler
Copy link
Contributor

This is an improvement. I suggest we merge something soon, and then we can continue to refine it further as later PRs. Making it readable at all on small displays seems important to me.

This improves small-screen readability and removes/moves extraneous
information for easier skimming.

Signed-off-by: Ben Cotton <[email protected]>
@funnelfiasco funnelfiasco force-pushed the issue99-improve_presentation branch from 51bbccb to a7a47dc Compare December 20, 2024 19:10
@funnelfiasco
Copy link
Contributor Author

It made me very sad to remove my emdashes, but I did.

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.

Proposal: Human-readable format should not be a spreadsheet or table-style document
4 participants