[Feat] Automatically link glossary entries#106
Open
ByteOtter wants to merge 2 commits into
Open
Conversation
✅ Deploy Preview for gardenlinux-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
ByteOtter
force-pushed
the
feat/auto-glossar
branch
5 times, most recently
from
1b9afe9 to
9298e07
Compare
ByteOtter
force-pushed
the
feat/auto-glossar
branch
from
9298e07 to
19692aa
Compare
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de> On-behalf-of: SAP <tiara.hock@sap.com>
ByteOtter
force-pushed
the
feat/auto-glossar
branch
from
c79122f to
3fbd693
Compare
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de> On-behalf-of: SAP <tiara.hock@sap.com>
ByteOtter
force-pushed
the
feat/auto-glossar
branch
from
3fbd693 to
783fc3e
Compare
ByteOtter
added
documentation
yeoldegrove
requested changes
Jul 14, 2026
yeoldegrove
left a comment
yeoldegrove
left a comment
Contributor
There was a problem hiding this comment.
In general, I would like this search/replace to not run on the make aggregate(-|) steps but only on the make build steps to not leave unstaged files in git.
Comment on lines
+61
to
+66
| ::: details Developer Information | ||
| The auto glossary system is designed to accept a new custom `entry_format` through which | ||
| the shortcode `{glossary:*}` can be replaced with a new custom pattern. | ||
|
|
||
| Check the source code for more information. | ||
| ::: |
Contributor
There was a problem hiding this comment.
I like that we hide this behind a developer block as I guess "nobody will use this feature". It's good to have it, though.
Comment on lines
+110
to
+140
| ## Auto-Linking | ||
|
|
||
|
|
||
|
|
||
| Auto-linking creates links for glossary terms without requiring explicit markers. This feature is disabled by default. | ||
|
|
||
| With auto-linking enabled, input text: | ||
|
|
||
| ``` | ||
| Deploy Gardenlinux on AWS using KVM virtualization. | ||
| ``` | ||
|
|
||
| Becomes: | ||
|
|
||
| ```markdown | ||
| Deploy [Garden Linux](/reference/glossary#garden-linux) on [AWS](/reference/glossary#aws) using [KVM](/reference/glossary#kvm) virtualization. | ||
| ``` | ||
|
|
||
| Auto-linking rules: | ||
| - Links only the first occurrence of each term | ||
| - Matches longer terms first (`Garden Linux` before `Linux`) | ||
| - Case-insensitive matching | ||
| - Respects word boundaries | ||
| - Preserves code blocks and inline code | ||
| - Does not modify existing links | ||
|
|
||
| ::: warning | ||
| This feature is disabled by default as it is highly experimental and intended for research work only. | ||
|
|
||
| **Contributors must not rely on this feature when contributing documentation.** | ||
| ::: |
Contributor
There was a problem hiding this comment.
Could you remove this and also the feature until it is ready? It adds a lot of new code and in it's current state it is not very helpful.
I like the feature, though and would be happy if we get this included if it works properly.
| Process glossary links manually: | ||
|
|
||
| ```bash | ||
| make glossary |
Contributor
There was a problem hiding this comment.
This does not work for me currently. No files are touched.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
This PR adds a new feature to allow users to quickly link a given abbreviation or name to a glossary entry.
This will look like this in any given text:
This shorthand will then be replaced into a clickable link automatically during aggregation or by running
make glossary.In addition, this PR fixes a bunch of formatting and linting issues throughout the codebase, strengthens our linters by minor configuration changes and introduces a new testsuite for this feature.
Preliminary usage documentation can be found in the deploy preview: https://deploy-preview-106--gardenlinux-docs.netlify.app/contributing/documentation/auto-glossary.html
Which issue(s) this PR fixes:
Fixes: gardenlinux/gardenlinux#4637
Definition of Done:
main)Special notes for your reviewer:
Release note: