Skip to content

docs: clarify Hugo linkTitle guidance#3843

Merged
joaopgrassi merged 5 commits into
open-telemetry:mainfrom
Jaegeonyoon:docs-hugo-title-guidance
Jul 6, 2026
Merged

docs: clarify Hugo linkTitle guidance#3843
joaopgrassi merged 5 commits into
open-telemetry:mainfrom
Jaegeonyoon:docs-hugo-title-guidance

Conversation

@Jaegeonyoon

@Jaegeonyoon Jaegeonyoon commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

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:

  • linkTitle is a short version of the page title shown in the website's left side navigation
  • contributors should prefer short sub-area names such as Spans, Metrics, or Resources
  • linkTitle should be omitted when it would be identical to the page title
  • title and heading capitalization should follow the OpenTelemetry documentation style guide

Important

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

  • CONTRIBUTING.md guidelines followed.
  • Links to prototypes or existing instrumentations (when adding or changing conventions)
  • Disclose AI usage, see OTel GenAI policy:
    • no AI used
    • AI-assisted
    • bulk AI-generated
  • I have the experience and knowledge necessary to understand, review, and validate all content in this PR.1

Footnotes

  1. Yes, I can answer maintainer questions about the content of this PR without using AI.

Comment thread CONTRIBUTING.md Outdated
@lmolkova

lmolkova commented Jul 2, 2026

Copy link
Copy Markdown
Member

@chalin can you please take a look when you have a moment? Thanks!

@lmolkova lmolkova added the Skip Changelog Label to skip the changelog check label Jul 2, 2026
@lmolkova lmolkova moved this from Untriaged to Awaiting codeowners approval in Semantic Conventions Triage Jul 2, 2026
Comment thread CONTRIBUTING.md Outdated

@chalin chalin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

Comment thread CONTRIBUTING.md Outdated
@github-project-automation github-project-automation Bot moved this from Awaiting codeowners approval to Blocked in Semantic Conventions Triage Jul 3, 2026

@chalin chalin left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@github-project-automation github-project-automation Bot moved this from Blocked to Needs More Approval in Semantic Conventions Triage Jul 4, 2026
@joaopgrassi
joaopgrassi added this pull request to the merge queue Jul 6, 2026
Merged via the queue into open-telemetry:main with commit 4c6b91b Jul 6, 2026
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Skip Changelog Label to skip the changelog check

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

7 participants