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

Update README #5

Merged
merged 2 commits into from
Jun 6, 2024
Merged

Conversation

felixge
Copy link
Member

@felixge felixge commented Jun 6, 2024

Update README to reflect GA status of the feature.

@felixge felixge requested a review from nsrip-dd June 6, 2024 06:33
README.md Outdated
@@ -2,11 +2,8 @@

datadog-pgo is a tool for integrating continuous [profile-guided optimization](https://go.dev/doc/pgo) (PGO) into your Go build process. It fetches representative CPU profiles from Datadog and merges them into a `default.pgo` file that is used by the Go toolchain to optimize your application.

## ⚠️ Public Beta
You can learn more about this feature in our [official documentation](https://github.com/DataDog/documentation/blob/master/content/en/profiler/guide/save-cpu-in-production-with-go-pgo.md) as well as in [our announcement blog post](https://docs.datadoghq.com/profiler/guide/save-cpu-in-production-with-go-pgo/).
Copy link

Choose a reason for hiding this comment

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

For the official documentation link, perhaps you want this instead of a link to the markdown on github? https://docs.datadoghq.com/profiler/enabling/go/#save-up-to-14-cpu-in-production-with-pgo

Copy link
Member Author

Choose a reason for hiding this comment

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

Ugh, both links were wrong 🤦 . Thanks for catching this. Should be fixed now. PTAL again.

@felixge felixge requested a review from nsrip-dd June 6, 2024 11:12
Copy link

@nsrip-dd nsrip-dd left a comment

Choose a reason for hiding this comment

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

LGTM

@felixge felixge merged commit 2945a87 into main Jun 6, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants