Page MenuHomePhabricator

MPIC: Correct typographic styles
Open, Needs TriagePublic3 Estimated Story Points

Description

Problem

Headings and body text in MPIC are not aligned with Codex's Typographic styles and form standards.

Solution

To make the tool look consistent with other wiki environments, we should apply the right properties to its different typographic styles.

Specifications are provided both as discrete values and Codex tokens. Using the latter is advice to ensure adaptable consistency:

1. Update h1 titles' style
Font-size: 1.75rem (@font-size-xxx-large)
Line-height: 1.25 (@line-height-xxx-small)
Font-family: 'Linux Libertine', 'Georgia', 'Times', 'Source Serif Pro', serif (@font-family-serif)
Font-weight: 400 (@font-weight-normal)
Color: #f8f9fa [dark mode], #000 [light mode] (@color-emphasized)

h1-example.png (280×2 px, 54 KB)

2. Apply a h2 style to form section titles
Font-size: 1.5rem (@font-size-xx-large)
Line-height: 1.25 (@line-height-xxx-small)
Font-family:'Linux Libertine', 'Georgia', 'Times', 'Source Serif Pro', serif (@font-family-serif)
Font-weight: 400 (@font-weight-normal)
Color: #f8f9fa [dark mode], #000 [light mode] (@color-emphasized)

Screenshot 2024-10-18 at 11.30.48.png (494×1 px, 55 KB)

(It might also be worth evaluating whether form sections should actually be h2 headings, which would help improve the page's semantic structure and accessibility)

3. Adjust body text
The base font-size of all body text (all non-title elements such as descriptions, labels, table contents, etc.) should be 0.875rem (@font-size-small) instead of the discrete 15px.

Labels included in the forms (fields, text inputs outside or inside modules, radio buttons, checkboxes) display incorrect colors on dark mode (#ebebeba3, #a2a9b1). In all cases, they should be #eaecf0 (@color-base).

4. Apply correct color to links

All the links included in the application should be blue (@color-progressive) by default instead of green. Their color should translate to the right shade in dark mode.
For simplicity, and to ensure that this element displays the right colors in its different states, we could use the Link mixin provided by Codex.

Acceptance criteria
  • MPIC's font styles are consistent with Wikimedia standards

Event Timeline

Milimetric set the point value for this task to 3.Tue, Oct 29, 2:31 PM

Change #1091784 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[operations/deployment-charts@master] Metrics Platform Instrument Configuration: Deploying to staging

https://gerrit.wikimedia.org/r/1091784

Change #1091785 had a related patch set uploaded (by Clare Ming; author: Clare Ming):

[operations/deployment-charts@master] Metrics Platform Instrument Configuration: Deploying to production

https://gerrit.wikimedia.org/r/1091785

Change #1091784 merged by jenkins-bot:

[operations/deployment-charts@master] Metrics Platform Instrument Configuration: Deploying to staging

https://gerrit.wikimedia.org/r/1091784

Change #1091785 merged by jenkins-bot:

[operations/deployment-charts@master] Metrics Platform Instrument Configuration: Deploying to production

https://gerrit.wikimedia.org/r/1091785

Thanks for all the changes! Everything is looking really great 💯 I just need to request a small fix:

  • The labels within modules (Duration, Feature variants) display the wrong color in dark mode: #a2a9b1 instead of #eaecf0; and in light mode: #54595d instead of #202122 (in all cases: @color-base)

Screenshot 2024-11-19 at 20.13.19.png (351×677 px, 47 KB)
Screenshot 2024-11-19 at 20.25.36.png (334×650 px, 46 KB)

Note – Just for transparency. No action required nor blocking for this task: I noticed that the initially specified 0.875rem body font looks excessively small, specially on retina displays. We have some design freedom thanks to the fact that we're building outside of MW, so I'm evaluating suggesting an increase of the body font to 1rem (@font-size-medium), to enhance its readability across displays. The problem is that this would also require an adjustment of the vertical spacing. I'll consult with other designers and clearly specify any changes if necessary.

This comment was removed by Sfaci.

There is a MR ready for review related to the pending issue regarding the wrong style mentioned here: https://gitlab.wikimedia.org/repos/data-engineering/mpic/-/merge_requests/133