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 mem leak tutorial #14110

Merged
merged 21 commits into from
Dec 18, 2019
Merged

Conversation

sdmaclea
Copy link
Contributor

Summary

Add tutorials to walk through key use cases

@sdmaclea sdmaclea requested a review from mairaw as a code owner August 30, 2019 18:41
@sdmaclea sdmaclea self-assigned this Aug 30, 2019
@sdmaclea sdmaclea added this to the September 2019 milestone Aug 30, 2019
@sdmaclea
Copy link
Contributor Author

sdmaclea commented Oct 7, 2019

@samsp-msft I just rebased this on the #13981 PR. It should represent what I have so far. Feedback would be appreciated.

@sdmaclea sdmaclea mentioned this pull request Oct 14, 2019
@sdmaclea sdmaclea changed the title WIP Diagnostic scenarios Diagnostic scenarios Oct 14, 2019
@sdmaclea
Copy link
Contributor Author

@mairaw I would like a first review when you get chance

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.

To make this less overwhelming, I've entered comments for the first article only and we can go from there.

@BillWagner BillWagner added doc-idea Indicates issues that are suggestions for new topics [org][type][category] and removed new-content labels Nov 19, 2019
@sdmaclea sdmaclea modified the milestones: September 2019, January 2020 Nov 21, 2019
Add tutorials to walk through key use cases.
Remove tutorial overview
Use dotnetcli or console as appropriate
Add applies to comment
Add preparing sections
Fix URLs
Fix commands
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. Looks great. Left some comments for you to consider.

docs/core/diagnostics/index.md Outdated Show resolved Hide resolved
docs/core/diagnostics/index.md Show resolved Hide resolved
docs/core/diagnostics/sample-debug-target.md Outdated Show resolved Hide resolved
docs/core/diagnostics/sample-debug-target.md Outdated Show resolved Hide resolved
docs/core/diagnostics/sample-debug-target.md Outdated Show resolved Hide resolved
docs/core/diagnostics/tutorial_memory_leak.md Outdated Show resolved Hide resolved
docs/core/diagnostics/tutorial_memory_leak.md Outdated Show resolved Hide resolved
docs/core/diagnostics/tutorial_memory_leak.md Outdated Show resolved Hide resolved
docs/core/toc.yml Outdated Show resolved Hide resolved
ms.author: stmaclea
ms.date: 10/14/2019
---
# Sample debug target
Copy link
Contributor

Choose a reason for hiding this comment

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

Would it better to call this "Sample .NET Core diagnostics app" or something like that?

Copy link
Contributor Author

@sdmaclea sdmaclea Dec 17, 2019

Choose a reason for hiding this comment

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

sample debug target does sound a bit too formal. I don't like "Sample .NET Core diagnostics app" it doesn't convey the bad examples message. I did a quick look for common terminology, but didn't find anything. I chose to keep it as is.

@sdmaclea sdmaclea mentioned this pull request Dec 17, 2019
@sdmaclea
Copy link
Contributor Author

@mairaw I applied most of your suggestions as is. Feel free to make any final edits.

Copy link
Member

@Youssef1313 Youssef1313 left a comment

Choose a reason for hiding this comment

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

nit: Add periods.

docs/core/diagnostics/debug-memory-leak.md Outdated Show resolved Hide resolved
docs/core/diagnostics/debug-memory-leak.md Outdated Show resolved Hide resolved
docs/core/diagnostics/debug-memory-leak.md Outdated Show resolved Hide resolved
Prefer the readme in the samples repo
Add periods
Consistent list marker
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.

Thank you so much @sdmaclea! I've made some minor changes but looks good to publish.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli/subsvc doc-idea Indicates issues that are suggestions for new topics [org][type][category]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants