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

Design follow-up fixes #216

Merged
merged 5 commits into from
Aug 12, 2024
Merged

Design follow-up fixes #216

merged 5 commits into from
Aug 12, 2024

Conversation

JakeSCahill
Copy link
Contributor

@JakeSCahill JakeSCahill commented Aug 9, 2024

Fixes a few issues mentioned in https://github.com/redpanda-data/documentation-private/issues/2637

  • Admonitions:
    • Adds opacity 50% to the background color of admonitions in dark mode.
    • Adds a different color to the important admonitions to make it distinct from the note admonition.
  • Home page: Makes the header Redpanda red for better brand awareness.
  • Metadata and breadcrumbs: Include the product name so users can identify where they are
2024-08-09_13-36-41.mp4

2024-08-12_16-24-19

2024-08-12_16-23-58

2024-08-12_16-23-20

Copy link

netlify bot commented Aug 9, 2024

Deploy Preview for docs-ui ready!

Name Link
🔨 Latest commit 86610f5
🔍 Latest deploy log https://app.netlify.com/sites/docs-ui/deploys/66ba3708e061d00008691801
😎 Deploy Preview https://deploy-preview-216--docs-ui.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@Deflaimun
Copy link
Contributor

Deflaimun commented Aug 9, 2024

Note and important still look too close to each other. Suggest we either stick to
Note -> blue
Important/tip -> green
warning/caution -> yellow or orange
danger -> red

Or merge note and important into a single admonition. Conceptually, they're too close too.

Colors for comparison. With the 50% opacity they look super close to each other

Important
image
Note
image

@yougotashovel
Copy link
Contributor

yougotashovel commented Aug 12, 2024

@Deflaimun

Note and important still look too close to each other. Suggest we either stick to Note -> blue Important/tip -> green warning/caution -> yellow or orange danger -> red

Or merge note and important into a single admonition. Conceptually, they're too close too.

Colors for comparison. With the 50% opacity they look super close to each other

Important image Note image

I suggested originally inverting the color from the palette, so that it will have roughly the same level of importance from the background color. You can use math to help you choose these colors.

All of the color choices should be relative to the most prominent color on the page, which in this case is the page background color.

e.g:
light mode

  • white background = gray.0 orwhite
  • admonition background = <color>.100
  • this is roughly a 100 point difference between background and highlighted background

dark mode

  • dark background = darkblue.900 which is pretty close to black as it's already a "dark color" it's closer to something like <color>.1000
  • admonition background = <color>.900
  • this allows us to get pretty close to that 100 point difference.

image

@Feediver1
Copy link
Contributor

Feediver1 commented Aug 12, 2024

Rather than "Select a product", wondering if we should say "Select a platform". Then, once in Cloud or Self-managed, you can select the actual product doc you want (explanations and links will be in the landing pages (forthcoming)). For example, for Cloud, the products are Serverless, BYOC, and Dedicated.

@Feediver1
Copy link
Contributor

Not seeing an update here for the tab name (Enterprise > Self-managed) @JakeSCahill

@JakeSCahill
Copy link
Contributor Author

JakeSCahill commented Aug 12, 2024

Not seeing an update here for the tab name (Enterprise > Self-managed) @JakeSCahill

redpanda-data/docs#684

@JakeSCahill
Copy link
Contributor Author

Rather than "Select a product", wondering if we should say "Select a platform". Then, once in Cloud or Self-managed, you can select the actual product doc you want (explanations and links will be in the landing pages (forthcoming)). For example, for Cloud, the products are Serverless, BYOC, and Dedicated.

redpanda-data/docs-site#70

@JakeSCahill
Copy link
Contributor Author

Update admonitions

like this? 86610f5

@JakeSCahill JakeSCahill merged commit 2491c6c into main Aug 12, 2024
6 checks passed
@JakeSCahill JakeSCahill deleted the fix-2637 branch August 12, 2024 17:23
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.

5 participants