opentelemetry.io
opentelemetry.io copied to clipboard
[CI/infra] Doc file names: use kebab-case not snake_case
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
kebabs sound good to me
Hi , I would like to work on this issue
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.
@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!
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.
@open-telemetry/demo-approvers - FYI, I'll be applying this site-wide preference to the demo docs shortly.
🥙