Skip to content

Update ActivityUserGuide.md #49818

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

Merged
merged 1 commit into from
Mar 19, 2021
Merged

Update ActivityUserGuide.md #49818

merged 1 commit into from
Mar 19, 2021

Conversation

noahfalk
Copy link
Member

Refer activity guide to the official docs

dotnet/docs#23313 is bringing more enhancements shortly

Refer activity guide to the official docs

dotnet/docs#23313 is bringing more enhancements shortly
@ghost
Copy link

ghost commented Mar 18, 2021

Tagging subscribers to this area: @tarekgh, @tommcdon, @pjanotti
See info in area-owners.md if you want to be subscribed.

Issue Details

Refer activity guide to the official docs

dotnet/docs#23313 is bringing more enhancements shortly

Author: noahfalk
Assignees: -
Labels:

area-System.Diagnostics.Tracing

Milestone: -

@noahfalk
Copy link
Member Author

cc @tarekgh @sywhang

@stephentoub
Copy link
Member

dotnet/docs#23313 is bringing more enhancements shortly

Once that's merged we'll delete this document?

Assuming it'll actually be merged shortly, we could just delete this doc now, no?

@tarekgh
Copy link
Member

tarekgh commented Mar 18, 2021

I would suggest deleting this doc and move any missing information to the new document. Keeping that with the new comment in the top will force the reader read this doc while they don't need to in most of the cases. Also, having one place for the doc would be easier pointing users to.

@noahfalk
Copy link
Member Author

noahfalk commented Mar 18, 2021

I would suggest deleting this doc and move any missing information to the new document

@tarekgh - Are you volunteering to do the work? : )
(Also I still wouldn't propose deleting the doc entirely, but deleting everything other than the link to the new doc would be fine once all useful info had been moved. I didn't volunteer to do that refactoring because I suspect it will take non-trivial effort to do it well and I don't have more time to spend on this task at the moment)

@tarekgh
Copy link
Member

tarekgh commented Mar 18, 2021

(Also I still wouldn't propose deleting the doc entirely, but deleting everything other than the link to the new doc would be fine once all useful info had been moved. I didn't volunteer to do that refactoring because I suspect it will take non-trivial effort to do it well and I don't have more time to spend on this task at the moment)

That is fine to keep the doc for now till we move the needed contents to the other place.

Are you volunteering to do the work? : )

Not in the current time but I wouldn't mind help in that in the future. I am simply curious why we need to keep the usage of DiagnosticSource with Activity? We need to discourage users from that and move to ActivitySource I guess.

I am approving this PR and we can look at refactoring in other time.

Copy link
Contributor

@sywhang sywhang left a comment

Choose a reason for hiding this comment

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

LGTM

@noahfalk
Copy link
Member Author

I am simply curious why we need to keep the usage of DiagnosticSource with Activity?

While I wouldn't encourage most users to do it, there are still some scenarios that can't be accomplished any other way. We also haven't yet replicated every relevant piece of useful guidance onto the official docs for the people who aren't using DiagnosticSource with Activity. I am making a bet (and perhaps it is a bad bet) that the people who find this doc and choose to keep reading it after seeing the obsoletion warning at best will learn something useful and at worst they'll decide it was a waste of their time to read and forget what they read in it.

@noahfalk noahfalk merged commit 9f93bcb into main Mar 19, 2021
@jkotas jkotas deleted the noahfalk-update_activity_guide branch March 19, 2021 03:11
@ghost ghost locked as resolved and limited conversation to collaborators Apr 18, 2021
@karelz karelz added this to the 6.0.0 milestone May 20, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants