Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[chore] Add anchors to individual attributes in a markdown table #1041 #1480

Merged
merged 16 commits into from
Oct 17, 2024

Conversation

RichardChukwu
Copy link
Contributor

Fixes #1041

Changes

  • Added anchor tags to individual attributes in the markdown table.

  • Each attribute now has a corresponding element, allowing direct linking to the specific attribute from the table of contents or other parts of the documentation.

  • The anchor is dynamically generated using the attribute’s name, converted to a URL-friendly format (lowercase, spaces replaced with hyphens).

  • This ensures that each attribute can be easily referenced by creating links to the anchor IDs.

Merge requirement checklist

docs/attributes-registry/android.md Outdated Show resolved Hide resolved
@joaopgrassi joaopgrassi assigned joaopgrassi and unassigned arminru Oct 16, 2024
Co-authored-by: Joao Grassi <[email protected]>
@joaopgrassi joaopgrassi added editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. docs labels Oct 17, 2024
@joaopgrassi
Copy link
Member

joaopgrassi commented Oct 17, 2024

Ah.. I forgot that the link check may not work/like the anchor links in the URL 😞. Hum not sure if there's a way around it. I will try to check.

Edit: tcort/markdown-link-check#331

@RichardChukwu
Copy link
Contributor Author

Ooh, alright

@joaopgrassi
Copy link
Member

I pushed a workaround that skips local anchor links for now. Let's see if it passes.

@RichardChukwu
Copy link
Contributor Author

RichardChukwu commented Oct 17, 2024

Hey @joaopgrassi I guess the test passed?

Thanks for the workaround. What next now?

@joaopgrassi
Copy link
Member

Needs more approvals, so we need to wait for others to review it as well.

Copy link
Contributor

@trisch-me trisch-me left a comment

Choose a reason for hiding this comment

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

thanks! lgtm

Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

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

Thanks for doing this!

It would also be great to update the markdown tables that already reference registry attributes.

E.g. here

| [`http.request.method`](/docs/attributes-registry/http.md) | string | HTTP request method. [1] | `GET`; `POST`; `HEAD` | `Required` | ![Stable](https://img.shields.io/badge/-stable-lightgreen) |

@RichardChukwu
Copy link
Contributor Author

RichardChukwu commented Oct 17, 2024

@lmolkova Sure, but I suggest that can be addressed in a different PR as a different issue after this is merged, for clarity sake.

Your thoughts?

@lmolkova
Copy link
Contributor

@RichardChukwu sure!

@lmolkova lmolkova merged commit a365a5e into open-telemetry:main Oct 17, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Add anchors to individual attributes in a markdown table
5 participants