fix(docs): swap caution and warning admonitions & theme update

[wesleyboar]

Overview

Caution

Link color is too light, because —

• new theme now uses --global-color-accent--light for colors
• old user-guide/css/tacc/core-styles.docs.css assigns different (brighter) value for --global-color-accent--light

— so adjust link color before merging.

Important

Swaps !!! caution and !!! warning in source text, so red/yellow does not change for user since I swapped the colors in the theme.

What? Why?

Admonitions, i.e. —

!!! caution
    Important text in a box.

— were using yellow for caution and red for warning, because of a mistake long ago. I fixed the mistake upstream. To make sure TACC-Docs does not swap colors, I update !!! caution to use !!! warning, and vice-versa.

Important

Changes link aliases from https://(www.)designsafe-ci.org/user-guide/ to /, so those links are not interpreted as absolute links be improvement to script that identifies external links._

What? Why?

There is a script that identifies external links, then:

• appends [↗] to them
• makes them open in a new window

That script now interprets http:// and https:// as external links (because it is simpler, reliable logic) but expects —

• authors to not use http:// and https:// for links on the same domain

— yet many links to pages on this same docs site are (unnecessarily, and now inappropriately) using http:// and https://.

Note

Accesibility changes:

• <h1> titles now darker (match body text)
• hyperlinks now brighter (distinct from text)

Related

requires:

• requires fix(theme): swap admonition caution and warning styling TACC/mkdocs-tacc#43
• also done for:
  • fix(docs): swap caution and warning admonitions & theme update TACC/TACC-Docs#179
  • chore(deps): theme update TACC/mkdocs-tacc-client#3

Changes

• changed admonition types across docs:
  • datadepot resources
  • deleted / redirect pages

Testing

Admonitions

1. Start server.

2. Compare —

   • http://127.0.0.1:8002/user-guide/datadepotrepo/resources/
   • https://www.designsafe-ci.org/user-guide/datadepotrepo/resources/

   — and —

   • http://127.0.0.1:8002/user-guide/deleted/
   • https://www.designsafe-ci.org/user-guide/deleted/

   — severities stay the same

Core-Styles 2.37.4 → 2.59.1

3. Verify no changes here:
   • http://127.0.0.1:8002/user-guide/usecases/overview/
     card--plain / card--image-top grids
   • http://127.0.0.1:8002/user-guide/managingdata/datatransfer/
     article.card--plain blocks
   • http://127.0.0.1:8002/user-guide/curating/policies/
     card--plain + tables

UI

Admonitions

before	after

[netlify]

✅ Deploy Preview for ds-user-guide ready!

Name	Link
🔨 Latest commit	3880a48
🔍 Latest deploy log	https://app.netlify.com/projects/ds-user-guide/deploys/6ac7b6063e8be80008e05375
😎 Deploy Preview	https://deploy-preview-293--ds-user-guide.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

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