-
Notifications
You must be signed in to change notification settings - Fork 888
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
Use consistent file name for data-model.md #2586
Use consistent file name for data-model.md #2586
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think we might have any incoming links that would break?
@chalin are there any changes that would need to be reflected on the website following this renaming? |
LGTM (prior to a review from @chalin as it may impact the docs in the OTel website). Other than that, we should have an 'official' suggestion somewhere saying "this-is-my-file.md" format is preferred (and also consider updating other related items, e.g. should |
It is possible. I am not sure there is a way to prevent it. |
We use (mostly) snake-case for file names in the repository. I renamed datamodel.md to data-model.md to be consistent.
e035558
to
10ec7ab
Compare
One possible way is to keep the existing file but shrink it to: This file has been moved to ... Anyways I think we shouldn't try to solve this problem. GitHub has permanent links, if folks use a non-permanent link, the default expectation is that it could break. |
@chalin can you please confirm that we are not breaking anything at opentelemetry.io by this renaming? |
Thanks for the original pings and apologies for the delayed response. Yes, a path aliases needed to be added, which is done in: |
We use (mostly) snake-case for file names in the repository.
I renamed datamodel.md to data-model.md to be consistent.