open-telemetry / opentelemetry.io

The OpenTelemetry website and documentation
https://opentelemetry.io
Creative Commons Attribution 4.0 International
537 stars 1.19k forks source link

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

Open chalin opened 3 years ago

chalin commented 3 years ago

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.

austinlparker commented 3 years ago

kebabs sound good to me

himanshu007-creator commented 3 years ago

Hi , I would like to work on this issue

chalin commented 3 years ago

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 commented 2 years ago

@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!

cartermp commented 2 years ago

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.

chalin commented 1 year ago

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

svrnm commented 1 year ago

🥙