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

Add guidance on how to work with hugo and format titles #1834

Open
lmolkova opened this issue Jan 27, 2025 · 2 comments
Open

Add guidance on how to work with hugo and format titles #1834

lmolkova opened this issue Jan 27, 2025 · 2 comments
Labels
docs tooling Regarding build, workflows, build-tools, ...

Comments

@lmolkova
Copy link
Contributor

lmolkova commented Jan 27, 2025

I hope we could do better in semconv and either automate or at least catch some of hugo and title issues during review.

A few things that could help:

  1. Is there a crash course on hugo (in the context of otel.io)? E.g.

    • we have <!--- Hugo front matter used to generate the website version of this page: ---> in some cases we have it in some other cases we don't - why?
    • Is there a good link we could add to contributing.md to help with incantations like path_base_for_github_subdir ?
    • How to rename/move files keeping website links
  2. Could we come up with some guidance on how to do things in semconv?
    E.g.

    • linkTitle is a short thing that does not include semconv name, just the sub-area within it. It should usually be Spans, Metrics, Resources, etc. It's in 'Sentence case'
    • Headings should use 'Title Case' (TBH I'd default to `Sentence case' everywhere)

Originally posted by @lmolkova in #1820 (review)

@lmolkova
Copy link
Contributor Author

See also

sentence case is my preference as well, and what Google recommends in it's style guide, see Headings:

#1820 (comment)

@chalin
Copy link
Contributor

chalin commented Jan 28, 2025

By implementing #1821, I hope to simplify (1), by:

For (2), here are some initial thoughts:

  • The points you make in the opening comment about linkeTitle and the use of sentence case are relevant.
  • Paths to doc pages from within /docs should not step outside of /docs only to come back in. We could test for this be reporting as an error any use of paths of the form ../docs/, but I'm not sure if there'd be any false positives (I don't think so). Cf. [editorial] Normalize path to docs from docs #1843

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs tooling Regarding build, workflows, build-tools, ...
Projects
Status: Core SemConv issues
Development

No branches or pull requests

2 participants