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

Consistent page title form and capitalization #169

Closed
chalin opened this issue Jul 6, 2023 · 2 comments · Fixed by #175
Closed

Consistent page title form and capitalization #169

chalin opened this issue Jul 6, 2023 · 2 comments · Fixed by #175
Assignees

Comments

@chalin
Copy link
Contributor

chalin commented Jul 6, 2023

This is what the side nav looks like for the semconv pages, as (soon to be) published on the OTel website:

image

(1) I'd like to suggest that all section titles (at this level and recurisively too) be of the form:

  • Xxx Semantic Conventions

instead of "Semantic Conventions for Yyy".

(2) There should be consistency in capitalization. I'm ok with whichever convention you use:Title Case or Sentence case -- the latter being the Google dev docs recommendation).

(3) Some titles are "Semantic Convention", singular. This should be fixed.

WDYT @jsuereth @joaopgrassi

/cc @svrnm @cartermp

@chalin
Copy link
Contributor Author

chalin commented Jul 7, 2023

Here is what it would look like if the titles were fixed:

image

This is taken from the preview https://deploy-preview-2982--opentelemetry.netlify.app/docs/specs/semconv/ of

@chalin
Copy link
Contributor Author

chalin commented Jul 7, 2023

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants