Comments (4)
@ltagliaferri how does this look? I put it as status - backlog for now.
from edu.
I think that maybe we should more aggressively create shortcode blurbs summarizing specific topics. I've been doing this recently with, for example, deep learning and CVSS. The issue I have with hover-and-show are the following:
- Discoverability: Visitors probably won't know we do this.
- Least surprise. You don't necessarily expect things to pop up when you hover and you might be trying to do something else, like copy. (I copy a lot and kind of hate popups that want me to share on Twitter or whatever.)
- Accessibility. Hover and show would only be accessible to mouse users, and for keyboard/screen reader users it would be too verbose.
That said, I do think we use terms like CVE and various othersecurity-related items without referring visitors to definitions, and that some articles that are more introductory should do this more. If we wanted to pursue this, maybe we could add more definitions from the glossary to our blurbs folder and then use them more prolifically as a house style.
Wondering what @sheesh and @SharpRake think.
from edu.
I agree with @smythp's points. While tooltips can be cooltips they aren't always intuitive and in something like docs I think an easier solution is to modularize heavily reused content like definitions with blurbs.
from edu.
This makes sense, thanks guys! Me & Lisa had discussed this about a year ago but I don't recall it ever being discussed with the whole team. I agree, adding more blurbs and expanding the glossary may be a better way to address this going forward. The implications for accessibility are also super important, so thanks for raising that.
from edu.
Related Issues (20)
- How to add custom modules to Caddy Image?
- Rust image missing rustdoc despite documentation claiming that it is included HOT 2
- Update maven example to handle "cannot create resource output directory" error HOT 1
- Course Payment Infrastructure
- Migration Doc: Node.js HOT 2
- Question on the chainguard courses HOT 3
- Thanos latest sidecar bug. HOT 2
- Melange getting started fails on step 4
- Add Windows chainctl documentation HOT 1
- docs: Missing non-dev image details for glibc-dynamic image HOT 1
- Blockquote support HOT 1
- h4 headings larger than h3 headings
- Mark Drake: AI Course review pt 2 (module 5) HOT 2
- Duplicate menu items on Academy site
- Style Guide Updates
- Review: Artifact registry pull through HOT 2
- Chainguard Registry architecture diagram HOT 5
- fix broken Assumable IDs redirects.
- Updating the Academy Cosign Materials
- Bug: Monospaced links in dark mode are visually indistinguishable HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from edu.