Add documentation on single file #1709
Conversation
|
@shirhatti @josalem @noahfalk This is a quick guide on the single file tools. It's a bit crude, but I wanted to get something to review. |
Co-authored-by: Noah Falk <noahfalk@users.noreply.github.com>
Co-authored-by: John Salem <josalem@microsoft.com>
|
|
||
| 1. *`curl` (available on Windows after 1706, macOS, and several distributions of Linux)* | ||
| ```sh | ||
| curl -JLO https://aka.ms/dotnet-dump/win-x64 |
There was a problem hiding this comment.
Can we add one of these into installation instruction on each tools' docs (i.e. dotnet-counters.md, dotnet-dump.md, dotnet-trace.md, etc.) as well? Or was there some explicit you didn't want to advertise it there?
There was a problem hiding this comment.
In the documentation folder? I might link them to this doc. Just adding a single link doesn't give much information on the requirements. I was trying to think of a way to combine them, but didn't see an easy way to caveat the requirements.
There was a problem hiding this comment.
I'm ok whether you include it there or just link it to this doc - just want this to be more discoverable since those docs are where people usually land.
| 3. *`pwsh` (PowerShell core)* | ||
|
|
||
| ```powershell | ||
| $resp = Invoke-WebRequest -Uri "https://aka.ms/dotnet-dump/win-x86" |
There was a problem hiding this comment.
Are all these links different ones on purpose? It might be more straightforward for the reader if you stuck to one link and use it across the three different shells.
There was a problem hiding this comment.
Powershell is only available on windows. I needed a windows link there. Wget is a downloadable tool, but it's not available by default on windows, so mostly that
Fixes #344