Page MenuHomePhabricator

docs: Use message component in TIP and WARNING notes in Codex
Open, LowPublic

Assigned To
None
Authored By
bmartinezcalvo
Dec 13 2022, 1:30 PM
Referenced Files
F35861867: Messages_02.png
Dec 13 2022, 6:50 PM
F35861866: Messages_01.png
Dec 13 2022, 6:50 PM
F35861861: Messages_02.png
Dec 13 2022, 5:29 PM
F35861860: Messages_01.png
Dec 13 2022, 5:29 PM
F35861548: Captura de Pantalla 2022-12-13 a las 14.25.30.png
Dec 13 2022, 1:30 PM
F35861546: Captura de Pantalla 2022-12-13 a las 14.25.12.png
Dec 13 2022, 1:30 PM

Description

Background/Goal

In some Codex Contribution guidelines' pages we are using notice (TIP) and warning (WARNING) messages but they should use the same styles as the Codex message component.

Captura de Pantalla 2022-12-13 a las 14.25.12.png (2,880×1,398 px, 1 MB)
Captura de Pantalla 2022-12-13 a las 14.25.30.png (2,880×1,410 px, 1 MB)
Tip message should use Notice message styles, using an info icon insteadWarning message should use the same styles as in message component, using an icon instead

Proposal

  • Tip message: background-color-progressive-subtle + border-color-progressive + color-progressive (if we use icon)
  • Warning message: background-color-warning-subtle + border-color-warning + color-warning (if we use icon)
Messages_01.png (2,880×1,874 px, 233 KB)
Messages_02.png (2,880×1,874 px, 233 KB)
Op.1: with iconsOp.2: without icons

Acceptance criteria (or Done)

  • Use warning Message in Warning notes in Codex
  • Use notice Message in Tip notes in Codex

Event Timeline

I would push back on the idea of using notice message styles for tips. Tips are meant to call out especially important information that can help someone who's trying to use or contribute to Codex. Notice messages are very subtle and easy to skip over due to their grey colors.

Unfortunately, we don't have a message style that corresponds to the current tip design, which uses our progressive colors. We could consider using the success message type with a custom icon.

I would push back on the idea of using notice message styles for tips. Tips are meant to call out especially important information that can help someone who's trying to use or contribute to Codex. Notice messages are very subtle and easy to skip over due to their grey colors.

Unfortunately, we don't have a message style that corresponds to the current tip design, which uses our progressive colors. We could consider using the success message type with a custom icon.

@AnneT what if we create then the tip message with progressive tones by using background-color-progressive-subtle and border-color-progressive? We could use a progressive-color icon or we could not use icon.

Messages_01.png (2,880×1,874 px, 233 KB)
Messages_02.png (2,880×1,874 px, 233 KB)
with iconwithout icon

@bmartinezcalvo I think that looks great! Would you want to do that just for the docs site, or make it a new type of Message?

@bmartinezcalvo I think that looks great! Would you want to do that just for the docs site, or make it a new type of Message?

@AnneT I would create this just for the docs site now to avoid confusions between Notice and Tip message in our design projects. But we can save this design for a new future Codex message type.

@bmartinezcalvo - can you please put an initial/proposed priority level on this task and move it to the Backlog column?
DST prioritization guidance

bmartinezcalvo triaged this task as Low priority.EditedJan 23 2023, 4:00 PM
bmartinezcalvo moved this task from Inbox to Backlog on the Design-System-Team board.

This task is low priority but @AnneT let me know the complexity of this task to know if we could solve it easily.

@bmartinezcalvo this wouldn't be too difficult, but we would need to either apply Message styles to the existing custom block markup, or try to alter the custom block markup to use either our Message Vue component or its markup. And, we'd probably have a bit of back-and-forth in terms of design and implementation. So this is not trivial, but fairly straightforward whenever we want to prioritize it.

@bmartinezcalvo this wouldn't be too difficult, but we would need to either apply Message styles to the existing custom block markup, or try to alter the custom block markup to use either our Message Vue component or its markup. And, we'd probably have a bit of back-and-forth in terms of design and implementation. So this is not trivial, but fairly straightforward whenever we want to prioritize it.

Let's leave this task as Low priority then.

bmartinezcalvo renamed this task from Use message component in TIP and WARNING notes in Codex to docs: Use message component in TIP and WARNING notes in Codex.Mar 13 2025, 1:15 PM
bmartinezcalvo updated the task description. (Show Details)

We already updated the Tip messages in Codex to be the most similar to our Codex Message. I guess we can solve this task. @AnneT could you confirm?