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

Rename the metrics new_api.md to api.md and updated links #1672

Merged
merged 2 commits into from
May 6, 2021

Conversation

reyang
Copy link
Member

@reyang reyang commented May 5, 2021

This is the 2nd part of the change, the 1st part is covered by #1674.

Previously we've decided to make progress on the metrics API spec by creating a separate new_api.md doc just to make PR review easier.

Now that the metrics API spec is getting in shape, we've discussed in the Apr. 29th Metrics API/SDK spec SIG meeting that we will rename it to api.md in early May.

Changes

  • Renamed new_api.md to api.md.
  • Removed old_api.md.
  • Made necessary updates to the links.

Related oteps

@reyang reyang requested review from a team May 5, 2021 22:07
@reyang reyang changed the title Rename the metrics new_api to api (and api to old_api for now) Rename the metrics new_api.md to api.md (and api.md to old_api.md for now) May 5, 2021
@reyang reyang added spec:metrics Related to the specification/metrics directory area:api Cross language API specification issue labels May 5, 2021
Copy link
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@reyang I think if you do it in two commits (not sure if renaming is enough or if an explicit git mv is necessary), it should keep the file history intact. This way, one would also be able to find the respective PRs including context for each line using git blame.

@reyang
Copy link
Member Author

reyang commented May 6, 2021

@reyang I think if you do it in two commits (not sure if renaming is enough or if an explicit git mv is necessary), it should keep the file history intact. This way, one would also be able to find the respective PRs including context for each line using git blame.

@arminru thanks for calling this out. Please take a look at this which shows that git blame is smart enough to show all the history on the new API doc.

Update: after taking a closer look I noticed some lines actually confused git blame. So I'm splitting the PR into two parts as suggested by @arminru, and here goes the 1st part #1674.

@reyang reyang force-pushed the reyang/flips-metrics-old-new-apis branch from 98a6377 to 8d8593b Compare May 6, 2021 22:05
@reyang reyang changed the title Rename the metrics new_api.md to api.md (and api.md to old_api.md for now) Rename the metrics new_api.md to api.md and updated links May 6, 2021
@jmacd jmacd merged commit 4a05eea into open-telemetry:main May 6, 2021
@reyang reyang deleted the reyang/flips-metrics-old-new-apis branch October 4, 2021 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Cross language API specification issue spec:metrics Related to the specification/metrics directory
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants