-
Notifications
You must be signed in to change notification settings - Fork 5.9k
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
Create diagnosticsource-getting-started.md #29255
Create diagnosticsource-getting-started.md #29255
Conversation
This is a rough draft, all suggestions appreciated.
docs/core/diagnostics/diagnosticsource-instrumentation-consumption.md
Outdated
Show resolved
Hide resolved
docs/core/diagnostics/diagnosticsource-instrumentation-consumption.md
Outdated
Show resolved
Hide resolved
docs/core/diagnostics/diagnosticsource-instrumentation-consumption.md
Outdated
Show resolved
Hide resolved
docs/core/diagnostics/diagnosticsource-instrumentation-consumption.md
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM thanks!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some general guidance that explains a lot of my comments:
- Okay to use "you" but not "we" or "our".
- Shorten sentences to help with localization.
- Use active voice over passive.
Use you instead of we, shorten sentences to help with localization, use active voice, comments should be capitalized and have punctuation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In general, I think we should consolidate the code samples into all-inclusive samples and then break down their contents. Users will want to be able to visit this guide and leave with a snippet of code they can build on. Having everything broken up makes that a complex task of grokking the whole page.
The best way to accomplish that would be to put all the code into a *.cs file and check that in with a *.csproj file so we can verify that it compiles. And then add snippet tags (you can name them anything; the format is The docs markdown to reference a snippet looks like:
And you could have a note in the tutorial with a link to the *.cs file to see the entire example? Or, if you think it's useful as a code sample, you can check it into the dotnet/samples repo and then link to the sample. |
Add clarifying comments, URLs for the APIs and responded to suggestions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you change all the ```C# lines to ```csharp?
And for all the output code, they should be labeled as console
.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please also add the file to the table of contents (toc.yml). Sorry I didn't catch that earlier.
Only this file, or the entire diagnostics repo? Is this the toc.yml file you mentioned? https://github.com/dotnet/docs/blob/dev/mirogers/diagnosticsource-getting-started/docs/toc.yml |
Just this file, since it's new. The TOC file is at https://github.com/dotnet/docs/blob/main/docs/fundamentals/toc.yml. |
Fixes #49082 and fixes #3029