docs: clarify Hugo linkTitle guidance#3843
Merged
joaopgrassi merged 5 commits intoJul 6, 2026
Merged
Conversation
Member
|
@chalin can you please take a look when you have a moment? Thanks! |
arminru
approved these changes
Jul 3, 2026
chalin
suggested changes
Jul 3, 2026
chalin
left a comment
Contributor
There was a problem hiding this comment.
Thanks @Jaegeonyoon.
All: FYI, the original intent of the section "Hugo frontmatter" (which the PR edits) was to inform semconv authors about Hugo front-matter conventions -- especially since these were encoded via comments, which is non standard, but might soon change, see:
3 tasks
kamphaus
approved these changes
Jul 4, 2026
joaopgrassi
approved these changes
Jul 6, 2026
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
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.
Refs #1834
Changes
Clarified the Hugo front-matter section in
CONTRIBUTING.md.The old text explained that new Markdown files should have
linkTitle, but it did not say much about how contributors should actually choose one. This update makes the guidance more practical:linkTitleis a short version of the page title shown in the website's left side navigationSpans,Metrics, orResourceslinkTitleshould be omitted when it would be identical to the page titleImportant
Pull request acceptance is subject to the triage process as described in Issue and PR Triage Management.
PRs that do not follow the guidance above may be automatically rejected and closed.
Merge requirement checklist
Footnotes
Yes, I can answer maintainer questions about the content of this PR without using AI. ↩