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

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

Open
9 of 12 tasks
chalin opened this issue Sep 24, 2021 · 7 comments
Open
9 of 12 tasks

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

chalin opened this issue Sep 24, 2021 · 7 comments
Labels

Comments

@chalin
Copy link
Contributor

chalin commented Sep 24, 2021

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.

@chalin chalin added e1-hours Effort: < 8 hrs p2-medium cleanup/refactoring refactoring good first issue Good for newcomers help wanted Extra attention is needed labels Sep 24, 2021
@austinlparker
Copy link
Member

kebabs sound good to me

@himanshu007-creator
Copy link

Hi , I would like to work on this issue

@chalin
Copy link
Contributor Author

chalin commented Sep 30, 2021

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
Copy link
Contributor Author

chalin commented Jan 13, 2022

@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
Copy link
Contributor

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
Copy link
Contributor Author

chalin commented Feb 7, 2023

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

@svrnm
Copy link
Member

svrnm commented Feb 8, 2023

🥙

@chalin chalin added the CI/infra CI & infrastructure label Jan 31, 2024
@chalin chalin changed the title Doc file names: use kebab-case not snake_case [CI/infra] Doc file names: use kebab-case not snake_case Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants