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

Diagnostic CLI tools #13981

Merged
merged 45 commits into from
Oct 14, 2019
Merged

Diagnostic CLI tools #13981

merged 45 commits into from
Oct 14, 2019

Conversation

sdmaclea
Copy link
Contributor

Summary

Add documentation for adding and using the diagnostic command line tools.

@sdmaclea
Copy link
Contributor Author

This is a very early draft.

@sdmaclea sdmaclea force-pushed the diagnostic-tools branch 2 times, most recently from 85014ec to 4f33a22 Compare August 22, 2019 20:12
Copy link
Member

@noahfalk noahfalk left a comment

Choose a reason for hiding this comment

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

Thanks @sdmaclea ! I added a few small feedback items but this is a major improvement over where we have been.

docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-dump.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-dump.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-trace.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-trace.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-trace.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/installing.md Outdated Show resolved Hide resolved
@sdmaclea sdmaclea changed the title WIP Diagnostic CLI tools Diagnostic CLI tools Aug 26, 2019
@sdmaclea sdmaclea removed the WIP label Aug 26, 2019
@sdmaclea
Copy link
Contributor Author

@mairaw @rpetrusha Please review.

@sdmaclea sdmaclea requested a review from Thraka September 3, 2019 16:30
@sdmaclea
Copy link
Contributor Author

sdmaclea commented Sep 4, 2019

@mairaw @rpetrusha @Thraka Please review.

@sdmaclea
Copy link
Contributor Author

@mairaw @rpetrusha @Thraka ping

@mairaw
Copy link
Contributor

mairaw commented Sep 12, 2019

Apologies on missing the multiple pings for reviews @sdmaclea! I'll review this soon.

Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

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

Thanks @sdmaclea. Left some comments for you to consider.

docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/cli-tools/dotnet-counters.md Outdated Show resolved Hide resolved
docs/core/diagnostics/index.md Show resolved Hide resolved
docs/core/diagnostics/index.md Outdated Show resolved Hide resolved
docs/core/diagnostics/index.md Outdated Show resolved Hide resolved
docs/core/diagnostics/index.md Outdated Show resolved Hide resolved
docs/toc.yml Outdated Show resolved Hide resolved
@sdmaclea
Copy link
Contributor Author

sdmaclea commented Oct 2, 2019

@mairaw I believe your feedback has been addressed. Please have another look.

@sdmaclea sdmaclea modified the milestones: August 2019, October 2019 Oct 4, 2019
@sdmaclea
Copy link
Contributor Author

@mairaw ping

@mairaw
Copy link
Contributor

mairaw commented Oct 14, 2019

I'm wondering if this content should live under https://docs.microsoft.com/en-us/dotnet/core/additional-tools/. Otherwise, we're creating a third-place on the TOC that talks about tools. We could break down that node into WCF and Diagnostics. Thoughts?

@sdmaclea
Copy link
Contributor Author

sdmaclea commented Oct 14, 2019

a third-place on the TOC that talks about tools. Thoughts?

We are trying to create a single landing page for diagnostic tools. We would like it to be easily discoverable. Something like https://golang.org/doc/diagnostics.html.

If we think about diagnostic tool users, there are two distinct questions:

  • Survey/Language Comparison: I am considering using C#, what tools/features are available
  • Reference/End user: I am using C#, how do I diagnose this scenario.

I think https://docs.microsoft.com/en-us/dotnet/core/additional-tools/ better suits the Survey case. I think https://docs.microsoft.com/en-us/dotnet/core/additional-tools/diagnostics is better for the Reference case. As a developer I tend to bias toward the Reference case, so that tends to be my innate preference.

I would probably include in both overviews to make it more discoverable.

#14110 will add more tutorial info related to some of these tools.

FWIW the existing https://docs.microsoft.com/en-us/dotnet/core/additional-tools/ overwhelmed me. It is loaded with heavy acronym usage, and very little conceptual background. I felt like I got whip lash trying to read it. It felt out of place. It needed to be in a WCF article.

Copy link
Contributor

@mairaw mairaw left a comment

Choose a reason for hiding this comment

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

:shipit:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants