-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
[CI/infra] Doc file names: use kebab-case not snake_case #780
Comments
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. |
🥙 |
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 ingetting-started.md
files. These should be consistently named.content/en/docs/js/instrumentation_examples.md
- JS examples: copyedits and file rename #1095semantic_conventions
directory names might be disappearing:The text was updated successfully, but these errors were encountered: