Skip to content

[chore] [editorial] Switch registry docs to pre-processed frontmatter#3671

Open
thompson-tomo wants to merge 3 commits into
open-telemetry:mainfrom
thompson-tomo:editoral/#1821_registryFrontMatter
Open

[chore] [editorial] Switch registry docs to pre-processed frontmatter#3671
thompson-tomo wants to merge 3 commits into
open-telemetry:mainfrom
thompson-tomo:editoral/#1821_registryFrontMatter

Conversation

@thompson-tomo

@thompson-tomo thompson-tomo commented Apr 28, 2026

Copy link
Copy Markdown
Contributor

Progresses #1821

Changes

This switches the registry docs to use frontmatter syntax rather than embedding the frontmatter in comments. Currently these comments need to be processed before they can be used on the website version.

This change will also help in reviews as the link title etc are front and center.

The docs now have an explicit title front matter property which matches h1.

No manual changes made other than to the jinja template.

Important

Pull requests acceptance are 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.
  • Change log entry added, according to the guidelines in When to add a changelog entry.
    • If your PR does not need a change log, start the PR title with [chore]
  • Links to the prototypes or existing instrumentations (when adding or changing conventions)

@github-actions

Copy link
Copy Markdown

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

@github-actions github-actions Bot added the Stale label May 13, 2026
@thompson-tomo thompson-tomo requested review from a team as code owners May 13, 2026 04:40
@github-actions github-actions Bot removed the Stale label May 14, 2026
@github-actions

Copy link
Copy Markdown

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

@github-actions github-actions Bot added the Stale label May 28, 2026
@github-actions

Copy link
Copy Markdown

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

@github-actions github-actions Bot added the Stale label Jun 14, 2026
@thompson-tomo

Copy link
Copy Markdown
Contributor Author

@chalin could you confirm the key thing needed for #1821 is setting of the title as a front matter property like done here by updating the title? Thanks

@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown

This PR has been labeled as stale due to lack of activity. It will be automatically closed if there is no further activity over the next 7 days.

@github-actions github-actions Bot added the Stale label Jul 2, 2026
@chalin

chalin commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Not stale.

@github-actions github-actions Bot removed the Stale label Jul 3, 2026
@joaopgrassi

Copy link
Copy Markdown
Member

@chalin I guess "code owner" here would be you. Can you approve to make sure from the OTel website things look ok?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Awaiting codeowners approval

Development

Successfully merging this pull request may close these issues.

4 participants