[Go] feat: update docs for dd-trace-go/v2 #25897
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Guide
|
Created DOCS-9639 for docs team review. |
bm1549
requested changes
Nov 27, 2024
There was a problem hiding this comment.
I partially reviewed this, but wanted to share some general feedback here
- I saw no indication of how we will be supporting
v1after thev2release, which will be a common question from our customers. We need to get in front of this and be clear about what will be back-ported (security issues, bugs, new feature, etc) and when v1 will be EOL, if ever - Many of the changes make
v2seem like a second-class option, rather than the new primary option. It's in preview right now so that'll change over time, but many of the docs sayuse this link (unless you're v2, then use this other link). If we're looking for adoption, this is not the way to go - We're indicating that there's a v2 option on many pages, but it's very likely that a customer landing on the page won't know what version they're using now, let alone which one they should be using. We shouldn't put an upgrade guide everywhere, but putting it in a few targeted places would go a long way
- We have some pages created as duplicates of older pages with v2 added in place of v1 - let's avoid that by utilizing tabs for
v1andv2 (preview). Over time, we can switch the tabs to bev2andv1 (legacy), but we'll need to maintain these long term so need to handle that up front - Although the updates to other language pages are probably fine, they should be reverted since the documentation team prefers our translators to be the ones updating those
content/en/profiler/guide/isolate-outliers-in-monolithic-services.md
Outdated
Show resolved
Hide resolved
...ent/en/security/application_security/software_composition_analysis/setup/compatibility/go.md
Outdated
Show resolved
Hide resolved
This reverts commit 310bd89.
Signed-off-by: Brian Deutsch <[email protected]>
…atform/apmlp-29/v2-docs
brett0000FF
requested changes
Dec 18, 2024
There was a problem hiding this comment.
Thanks for making these updates! I found a few more things to fix.
In addition to my suggested changes:
- Could we please revert the contents in https://github.com/DataDog/documentation/pull/25897/files#r1876820184, except for the changes we actually need? I don't want to accidentally overwrite the existing page.
- Question: I noticed we removed the OpenTracing docs. I know these were deprecated, but I wanted to double check this was intentional.
content/en/tracing/trace_collection/automatic_instrumentation/dd_libraries/go.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/custom_instrumentation/go/migration.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/custom_instrumentation/go/migration.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/custom_instrumentation/go/migration.md
Outdated
Show resolved
Hide resolved
|
@brett0000FF Yes, |
brett0000FF
reviewed
Dec 19, 2024
content/en/tracing/trace_collection/custom_instrumentation/go/migration.md
Outdated
Show resolved
Hide resolved
...ent/en/security/application_security/software_composition_analysis/setup/compatibility/go.md
Outdated
Show resolved
Hide resolved
content/en/security/application_security/threats/setup/compatibility/go.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/automatic_instrumentation/dd_libraries/go.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/custom_instrumentation/go/dd-api.md
Outdated
Show resolved
Hide resolved
bgdeutsch
approved these changes
Dec 20, 2024
brett0000FF
approved these changes
Dec 20, 2024
bm1549
reviewed
Dec 20, 2024
content/en/security/application_security/threats/setup/threat_detection/go.md
Outdated
Show resolved
Hide resolved
content/en/security/application_security/threats/setup/threat_detection/go.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/custom_instrumentation/go/otel.md
Outdated
Show resolved
Hide resolved
…detection/go.md Co-authored-by: Brian Marks <[email protected]>
Co-authored-by: Brian Marks <[email protected]>
sort import lines and fix typos Co-authored-by: Brian Marks <[email protected]>
bm1549
approved these changes
Jan 2, 2025
content/en/tracing/trace_collection/custom_instrumentation/go/migration.md
Outdated
Show resolved
Hide resolved
content/en/tracing/trace_collection/custom_instrumentation/go/migration.md
Outdated
Show resolved
Hide resolved
add v2 doc links Co-authored-by: Brian Marks <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do? What is the motivation?
Updates Go docs to
dd-trace-go/v2changes.Merge instructions