chainguard-dev / edu

Educational Resources for Software Supply Chain Security
https://edu.chainguard.dev
Other
74 stars 62 forks source link

Updates to Academy colors and fonts #1774

Open mcaveety opened 4 weeks ago

mcaveety commented 4 weeks ago

Hey, @smythp ! Unfortunately, I won't have a chance to tackle this before I head out today. I'm going to compile a list of things that I noticed on the Academy which might warrant an update. I suspect these are lingering from the old site theme.

Colors:

In dark mode, the tags, monospaced text, and selected article colors are still the same dark grey color from the old theme.

Screenshot 2024-08-16 at 12 56 02 PM

A similar case is seen with the copy-and-paste code blocks in our tutorials:

Screenshot 2024-08-16 at 12 56 56 PM

Same is true for tables:

Screenshot 2024-08-16 at 12 57 35 PM

There are thin, grey bars that remain from the old color theme. Also around the prev->next buttons. Super hard to pick out, but I think they should be neon purple.

Screenshot 2024-08-16 at 1 03 11 PM

Chart colors could do with a refresh...

Screenshot 2024-08-16 at 1 02 02 PM

There are also these numbered blocks on this article, https://edu.chainguard.dev/software-security/cves/cve-remediation/

Screenshot 2024-08-16 at 1 04 25 PM

Fonts / Text:

Code blocks no longer have text explaining what type of content they are. There used to be a "heading" to each code block with the content type (ex. sh, Dockerfile, Python, etc.) These content types were pulled from the markdown: ```Dockerfile .... or ``` Python ...

I could have sworn that a default font was displaying somewhere, but I think it was in the case of the above example... so if that functionality is gone, then the incorrect font went with it.

You've done such an incredible job on this effort, I by no means am trying to be nitpicky or critical of your work. I would have loved to jump on these changes if I had another week. The color palette thing is super tricky now that we're working with a purpleish base color, especially on dark mode. I strongly feel that the color palette needs to be expanded so that you have more flexibility. The old theme had many shades of grey that helped with these changes, but we've been using the secondary and tertiary colors with much difficulty. 🤷 just my thoughts on that.

Do what you wish with these suggestions! Do not hesitate to counter them, ignore them, etc. I'm mainly dumping this here for tracking since I won't have the opportunity to work on it myself.

smythp commented 4 weeks ago

No, these need a fix, I appreciate your pointing them out and I'll create a backlog item with these. The code heading really needs to come back as the most urgent item. Thanks for this, Michelle! I really appreciated your above-and-beyond attitude and your cheerful competence during your time with us this summer. Hope we get to work together again.