Skip to content

Conversation

@thompson-tomo
Copy link
Contributor

@thompson-tomo thompson-tomo commented Oct 4, 2025

Fixes #2824

Changes

The attribute tables have been re-organised in the following manner:

  • Attribute heading added above attribute tables to provide guidance as to what the table is and helps when multiple tables are rendered alongside one another
  • Attribute column heading renamed to Key as it relates to the key of the attribute which is a row
  • Examples column heading renamed to Example Values as it relates to the value of the attribute rather than an attribute
  • Type column heading renamed to Value Type as it relates to the type expected of the value rather than an attribute
  • Requirement and stability moved to be after key to give increased focus

The body field tables have been re-organised in the following manner:

  • Body Field column heading renamed to Field Name as it relates to the name of the body field which is a row
  • Examples column heading renamed to Example Values as it relates to the value of the body field rather than a body field
  • Type column heading renamed to Value Type as it relates to the type expected of the value rather than a body field
  • Requirement and stability moved to be after key to give increased focus

Note: if the PR is touching an area that is not listed in the existing areas, or the area does not have sufficient domain experts coverage, the PR might be tagged as experts needed and move slowly until experts are identified.

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)

@thompson-tomo thompson-tomo force-pushed the chore/#2824_NewColumnOrder branch from fc53148 to fc625d9 Compare October 12, 2025 01:13
@trask
Copy link
Member

trask commented Oct 13, 2025

Examples of new layout, anywhere there's an attribute table.

Stability and Requirement level have been moved closed to the beginning, and a couple of column renames:

image

@kamphaus
Copy link
Contributor

I think we should have either Summary or Description for both:
image

@thompson-tomo
Copy link
Contributor Author

thompson-tomo commented Oct 13, 2025

@kamphaus i agree that in the end they should match. I was planning to update the signal property headings/labels is in a follow up pr to not change too much here. That pr would also standardise title casing & : for all labels. I will raise that later this week and link the 2 pr's.

Unless @trask things it would be better to have 1 bigger pr to cover both.

@trask
Copy link
Member

trask commented Oct 13, 2025

I'd suggest leaving it as Description in this PR, and you can follow up later with a PR to propose changing them both at the same time

@thompson-tomo thompson-tomo requested a review from a team as a code owner October 19, 2025 04:32
@thompson-tomo
Copy link
Contributor Author

FYI @mmanciop this PR implements the reordering of the columns as you suggested.

@github-project-automation github-project-automation bot moved this from Untriaged to Needs More Approval in Semantic Conventions Triage Oct 22, 2025
@thompson-tomo
Copy link
Contributor Author

@joaopgrassi to avoid the continuous need to resolve conflicts, can you let me know once there is enough approvals and I will do it.

@joaopgrassi
Copy link
Member

Let's talk about it on the meeting today and then if no objections we can merge 👍

@jsuereth jsuereth moved this from Needs More Approval to Ready to be Merged in Semantic Conventions Triage Oct 27, 2025
@thompson-tomo thompson-tomo requested review from a team as code owners October 28, 2025 01:52
@thompson-tomo thompson-tomo force-pushed the chore/#2824_NewColumnOrder branch 5 times, most recently from fa7c015 to a3ce4c5 Compare October 28, 2025 02:37
@thompson-tomo thompson-tomo force-pushed the chore/#2824_NewColumnOrder branch from a3ce4c5 to 37af0c1 Compare October 28, 2025 02:44
@trask trask added this pull request to the merge queue Oct 28, 2025
Merged via the queue into open-telemetry:main with commit 512bf18 Oct 28, 2025
15 checks passed
@thompson-tomo thompson-tomo deleted the chore/#2824_NewColumnOrder branch October 28, 2025 04:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

Reorder columns in markdown tables: prioritize stability and req levels

10 participants