[Feat] Automatically link glossary entries - #106
Merged
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
July 9, 2026 15:18
1b9afe9 to
9298e07
Compare
ByteOtter
marked this pull request as ready for review
July 9, 2026 15:20
ByteOtter
force-pushed
the
feat/auto-glossar
branch
3 times, most recently
from
July 13, 2026 12:37
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.
ByteOtter
force-pushed
the
feat/auto-glossar
branch
from
July 15, 2026 10:27
a936581 to
e7b6dc6
Compare
Collaborator
Author
|
I also changed the behaviour of this feature to run right before the |
ByteOtter
force-pushed
the
feat/auto-glossar
branch
5 times, most recently
from
July 22, 2026 13:26
772de3e to
f3593b4
Compare
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de> On-behalf-of: SAP <tiara.hock@sap.com>
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de> On-behalf-of: SAP <tiara.hock@sap.com>
* Fix files not processing if name matching with "glossary" * Move auto glossary step from aggregation to build Signed-off-by: Tiara Lena Hock <hock@b1-systems.de> On-behalf-of: SAP <tiara.hock@sap.com> Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
Tests: Remove auto-link tests Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
* Reorder targets * Add new transform target * Remove glossary from build target * Add new publish target Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
Signed-off-by: Tiara Lena Hock <hock@b1-systems.de>
ByteOtter
force-pushed
the
feat/auto-glossar
branch
from
July 23, 2026 09:04
0768581 to
6290377
Compare
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: