docs icon indicating copy to clipboard operation
docs copied to clipboard

WIP redesign notes and admonitions

Open thaJeztah opened this issue 5 years ago • 2 comments
trafficstars

follow-up to https://github.com/docker/docker.github.io/pull/11640 (changes are in the last commit). It's still a WIP, but I had this branch lingering around on my machine as part of other changes, so I thought to push it as a PR to share.

This brings the initial work to redesign our notes and admonitions.

The following adminitions are supported:

  • info: generic note with "info" icon
  • tip: note with a "lightbulb" icon
  • check: note with a "check" icon
  • important: note with an exclamation mark
  • warning: note with an exclamation mark in a triangle

There are some alternative icons that I considered (currently commented in the style-sheet, but to be removed)

Things remaining:

  • update the examples and descriptions in "test.md"
  • tweak line-heights / typography
  • review uses of "warning" versus "important"; their purpose needs to be defined better (and styled accordingly)
  • color-schemes: we can likely use the same colors for "dark" and "light" mode. There's also some colors ("warning", e.g.) that use some tweaking.
  • add classes to existing notes to switch between a "regular" note to notes with an icon ("admonition").
  • removing "note" as first line: when using an icon, the icon can replace "note" in many cases; removing the "note" makes the note more compact without loosing meaning, so we should remove those.
  • for other notes, we should do the reverse: replace "note" with a more suitable introduction. I updated some pages to illustrate this. Setting a more descriptive first line can give notes a better context.

Examples

Here's some pages that could be used to view the updates styles:

  • https://5f9818658b67be00091dbe36--docsdocker.netlify.app/engine/security/https/
  • https://5f9818658b67be00091dbe36--docsdocker.netlify.app/engine/install/ubuntu/

Screenshots

And some screenshots

Screenshot 2020-10-27 at 13 51 56 Screenshot 2020-10-27 at 13 52 06 Screenshot 2020-10-27 at 13 55 33 Screenshot 2020-10-27 at 13 55 24

thaJeztah avatar Oct 27 '20 12:10 thaJeztah

:heavy_check_mark: Deploy Preview for docsdocker ready!

:hammer: Explore the source changes: fefd8e42a7ddcd3aabc9475c57ee5a3a5f1eb405

:mag: Inspect the deploy log: https://app.netlify.com/sites/docsdocker/deploys/60e559e104212e0008937f45

:sunglasses: Browse the preview: https://deploy-preview-11641--docsdocker.netlify.app

netlify[bot] avatar Oct 27 '20 12:10 netlify[bot]

/cc @usha-mandya we can look at this one in our call later

thaJeztah avatar Oct 27 '20 13:10 thaJeztah

Thanks for the pull request. We'd like to make our product docs better, but haven’t been able to review all the suggestions. As our docs have also diverged, we do not have the bandwidth to review and rebase old pull requests.

If the updates are still relevant, review our contribution guidelines and rebase your pull request against the latest version of the docs, then mark it as fresh with a /remove-lifecycle stale comment. If not, this pull request will be closed in 30 days. This helps our maintainers focus on the active pull requests.

Prevent pull requests from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

docker-robott avatar Nov 25 '22 01:11 docker-robott