opentelemetry.io icon indicating copy to clipboard operation
opentelemetry.io copied to clipboard

[CI/infra] Doc file names: use kebab-case not snake_case

Open chalin opened this issue 3 years ago • 7 comments

We need a consistent naming convention for doc file names. I suggest adopting kebab-case over other cases, snake_case in particular.

In particular note that we have some Getting started pages in getting_started.md files and other in getting-started.md files. These should be consistently named.

  • JS
    • [x] #841
    • [x] content/en/docs/js/instrumentation_examples.md - #1095
  • PHP
    • [x] https://github.com/open-telemetry/opentelemetry-php/pull/578
    • [x] #1119
  • Ruby
    • [x] https://github.com/open-telemetry/opentelemetry-ruby/pull/1120
    • [x] #1098
  • [x] Demo: #2293
  • [x] #2869
  • [x] #3019
  • [ ] All that might be left are the files in iconography.
  • [ ] Another thing to consider might be enforcing lowercase letters too
  • [ ] Spec -- probably won't want to changes these. Note that semconv are moving to a separate repo, and so the semantic_conventions directory names might be disappearing:
    $ find content -name "*_*" -type f | perl -pe 's|/_index.md||' | grep -e _
    ...
    content/en/docs/reference/specification/metrics/semantic_conventions
    content/en/docs/reference/specification/trace/semantic_conventions
    content/en/docs/reference/specification/schemas/file_format_v1.0.0.md
    content/en/docs/reference/specification/logs/semantic_conventions
    content/en/docs/reference/specification/resource/semantic_conventions/deployment_environment.md
    content/en/docs/reference/specification/resource/semantic_conventions/cloud_provider/aws
    content/en/docs/reference/specification/resource/semantic_conventions
    

chalin avatar Sep 24 '21 20:09 chalin

kebabs sound good to me

austinlparker avatar Sep 24 '21 20:09 austinlparker

Hi , I would like to work on this issue

himanshu007-creator avatar Sep 25 '21 04:09 himanshu007-creator

Come to think of it, this is interdependent with other issues I need to address in parallel. Thanks for the offer @himanshu007-creator, I'll let you know if/when you can contribute.

chalin avatar Sep 30 '21 16:09 chalin

@cartermp - when creating new files (e.g., https://github.com/open-telemetry/opentelemetry-ruby/pull/1060/files) please use kebab-case filenames.

If ever you choose to rename some of the snake_case filenames you've recently introduced to kebabe-case, please ensure you add a redirect rule (#668). Thanks!

chalin avatar Jan 13 '22 20:01 chalin

Yep, will do. In that case it was in keeping with the existing style. I'll do the kebab from now on in downstream unless told otherwise, and of course dot he same here.

cartermp avatar Jan 13 '22 20:01 cartermp

@open-telemetry/demo-approvers - FYI, I'll be applying this site-wide preference to the demo docs shortly.

chalin avatar Feb 07 '23 16:02 chalin

🥙

svrnm avatar Feb 08 '23 08:02 svrnm