Skip to content

Add id to glossary entries#35634

Merged
hestonhoffman merged 4 commits intomasterfrom
heston/glossary-ids
Mar 31, 2026
Merged

Add id to glossary entries#35634
hestonhoffman merged 4 commits intomasterfrom
heston/glossary-ids

Conversation

@hestonhoffman
Copy link
Copy Markdown
Contributor

@hestonhoffman hestonhoffman commented Mar 27, 2026

What does this PR do? What is the motivation?

We're working on creating a glossary data source for cdocs. But while working on that, I came across some issues that I wanted to improve in the source.

  • The primary fix is adding a non-translatable id to each term that can be used across languages.
  • The id is used for anchors and related_terms on the glossary page. Related term links now use an achorized id together with the translated Title as the display text.
  • The id is used for tooltips that reference glossary entries. There were a couple of places where the tooltip arguments had been translated and the tooltips were broken, so I fixed those.
  • Also fixes an issue where related term links weren't working correctly on translated pages.

Reviewing

The main files to review are the templating changes in layouts. There are a lot of changes to the term files, but these can be spot checked. They mostly just id fields and replace related terms with IDs.

Preview links:

Merge instructions

Merge readiness:

  • Ready for merge

@hestonhoffman hestonhoffman added the WORK IN PROGRESS No review needed, it's a wip ;) label Mar 27, 2026
@hestonhoffman hestonhoffman requested review from a team as code owners March 27, 2026 20:26
@github-actions github-actions bot added Architecture Everything related to the Doc backend Guide Content impacting a guide labels Mar 27, 2026
@hestonhoffman hestonhoffman removed the WORK IN PROGRESS No review needed, it's a wip ;) label Mar 27, 2026
@jeff-morgan-dd jeff-morgan-dd self-assigned this Mar 30, 2026
Comment thread layouts/partials/algolia/glossary.json
@hestonhoffman hestonhoffman requested a review from bgdeutsch March 31, 2026 16:16
@hestonhoffman hestonhoffman merged commit b0ffe7c into master Mar 31, 2026
21 of 22 checks passed
@hestonhoffman hestonhoffman deleted the heston/glossary-ids branch March 31, 2026 19:22
StefonSimmons pushed a commit that referenced this pull request Apr 16, 2026
* Add id to glossary entries

* Back out change to unrelated file

* Update

* Add guard for no id
genesor pushed a commit that referenced this pull request Apr 19, 2026
* Add id to glossary entries

* Back out change to unrelated file

* Update

* Add guard for no id
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Architecture Everything related to the Doc backend Guide Content impacting a guide

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants