-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Improve dump FAQ #44714
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
Improve dump FAQ #44714
Conversation
Fixes dotnet/diagnostics#4375 - The previous guidance for diagnosing dump permission issues did not mention the interaction between setcap and ptrace. I added that information as well as a more complete description of the ptrace access checking. - I replaced faq-dumps.yml with dump-faq.md. The yml file included markdown style links but that content was not properly rendered in the html page. Maybe there was a way to make that work as-is but it seemed simpler to use markdown similar to all the other pages in this part of the docs. I redirected links to the new page but left the old .yml page for now in case there were external direct links to it. - There was no link to the FAQ in the TOC so I added one. - I made some minor edits to the dump overview page that IMO improved clarity and flow of the text.
|
@hoyosjs - could you take a look? |
|
@noahfalk - A couple of preliminary comments:
|
OK, when I change it back to YAML should I strip the links out of the questions? Previously those links weren't rendering properly.
Do you think I should leave it out of the TOC? I was under the impression that all content was recommended to be in the TOC. |
Yes, I don't think you can have links in the questions.
No, it should absolutely be in the TOC. I'm just pointing out that it was probably accidentally dropped during that reorganization of the TOC. |
hoyosjs
left a comment
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.
Discussed feedback offline.
|
Part of me feels that YML FAQ optimization is nice, but the links are essential to this particular doc. Is there a strong opinion on it having to be yml? |
We don't need to remove all the links, just I think two of them that show up in the question text itself. |
Could you do something like this, basically move the links to the answer? |
|
I updated the PR back to yml and removed the links from the question. I didn't wind up adding the links to the answer either because in the revised text the links didn't fit as naturally. I don't think those two particular links were high importance. |
Co-authored-by: Genevieve Warren <[email protected]>
Fixes dotnet/diagnostics#4375
The previous guidance for diagnosing dump permission issues did not mention the interaction between setcap and ptrace. I added that information as well as a more complete description of the ptrace access checking.
There was no link to the FAQ in the TOC so I added one.
I made some minor edits to the dump overview page that IMO improved clarity and flow of the text.
Internal previews