olli/olli.puhakka.dev
Watch
1
0
Fork
You've already forked olli.puhakka.dev
 0
Code Issues 5 Pull requests Projects Releases Packages 2 Wiki Activity Actions

Tell apart glossary terms that share an abbreviation #14

Merged
olli merged 1 commit from feat/glossary-distinguish into dev 2026-10-15 02:05:02 +03:00
Conversation 0 Commits 1 Files changed 5 +172 -13
olli-agent commented 2026-10-15 02:02:55 +03:00
Collaborator
Copy link

MIG means Managed Instance Group (GCP) and Multi-Instance GPU (NVIDIA); RDS means AWS's Relational Database Service and Windows' Remote Desktop Services. This adds the second meaning of each as a card and links each pair, following Wikipedia's conventions.

  • Primary topic. The meaning the texts already use keeps the abbreviation as its label. The new cards are titled Multi-Instance GPU and Remote Desktop Services, with MIG and RDS as aliases, so a search finds both cards in each pair.
  • Hatnote. A new distinguish field shows "Not to be confused with …" ("Eri asia kuin …") on both cards.
  • Linking. A label now wins over another term's alias, so MIG in a text still links to Managed Instance Group.
  • Check. check-glossary.mjs allows a shared name only between two terms that distinguish each other, requires both to point to each other, and fails if the secondary term's own texts or notes use the abbreviation, since there it would link to the wrong card. It also adds A100 and H100 to the list of names that only look like abbreviations, and the abbreviation list gains RDP.
  • README describes the convention.

Testing

  • check-glossary.mjs and html-validate pass.
  • The check fails on four kinds of deliberately broken data.
  • In headless Chromium at 320px, light mode and English only, the hatnotes and the new cards render.
  • Not yet checked: docker compose, dark mode, Finnish and keyboard-only use.
MIG means Managed Instance Group (GCP) and Multi-Instance GPU (NVIDIA); RDS means AWS's Relational Database Service and Windows' Remote Desktop Services. This adds the second meaning of each as a card and links each pair, following Wikipedia's conventions. - **Primary topic.** The meaning the texts already use keeps the abbreviation as its label. The new cards are titled **Multi-Instance GPU** and **Remote Desktop Services**, with MIG and RDS as aliases, so a search finds both cards in each pair. - **Hatnote.** A new `distinguish` field shows "Not to be confused with …" ("Eri asia kuin …") on both cards. - **Linking.** A label now wins over another term's alias, so MIG in a text still links to Managed Instance Group. - **Check.** `check-glossary.mjs` allows a shared name only between two terms that distinguish each other, requires both to point to each other, and fails if the secondary term's own texts or notes use the abbreviation, since there it would link to the wrong card. It also adds A100 and H100 to the list of names that only look like abbreviations, and the abbreviation list gains RDP. - README describes the convention. **Testing** - `check-glossary.mjs` and `html-validate` pass. - The check fails on four kinds of deliberately broken data. - In headless Chromium at 320px, light mode and English only, the hatnotes and the new cards render. - Not yet checked: `docker compose`, dark mode, Finnish and keyboard-only use.
Tell apart glossary terms that share an abbreviation
All checks were successful
CI / lint (push) Successful in 3s
Details
CI / image (push) Successful in 4s
Details
CI / verify-staging (push) Successful in 58s
Details
d6572d2c61 
MIG means Managed Instance Group on GCP and Multi-Instance GPU on
NVIDIA hardware, and RDS is both AWS's database service and Windows'
Remote Desktop Services. The glossary mapped each name to one card, so
the second meaning had no place, and a reader thinking of it landed on
the wrong card without a hint.

Following Wikipedia, the meaning the texts already use stays the
primary topic and keeps the abbreviation as its label. The other gets a
card titled by its full name, with the abbreviation as an alias so a
search finds both. A new distinguish field shows a "Not to be confused
with" hatnote on both cards. A label now wins over another term's
alias when a text is linked, so MIG in a text still goes to Managed
Instance Group.

The check allows a shared name only between two terms that distinguish
each other, and fails if the secondary term's own texts or notes use
the abbreviation, since there it would link to the other card.
olli merged commit d6572d2c61 into dev 2026-10-15 02:05:02 +03:00
olli deleted branch feat/glossary-distinguish 2026-10-15 02:05:03 +03:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
olli/olli.puhakka.dev!14
No description provided.