Remove unsupported DNX-based DARC install instructions - #6538
Conversation
|
@copilot rather than just removing the whole section about using dnx, we should fix it by saying how it's correctly used, we can also give an example, something like |
Updated the doc to describe the correct DNX usage pattern and added an example that runs DARC directly with |
There was a problem hiding this comment.
Pull request overview
This PR updates the DARC client setup documentation to remove misleading/incorrect DNX-based installation guidance and keep the instructions aligned with the supported .NET CLI tool installation flow.
Changes:
- Removed the unsupported
dnx tool installand shell alias guidance from the DARC setup documentation. - Added a short example intended to show running DARC without a global tool install (currently still referencing
dnx).
| If you prefer to run darc without installing it as a global tool, you can use DNX to execute the package directly. For example: | ||
|
|
||
| For environments where the standard installation doesn't work, you can use DNX (dotnet execute) to run darc without a global installation: | ||
|
|
||
| ``` | ||
| dnx tool install Microsoft.DotNet.Darc --source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json --prerelease | ||
| ``` | ||
|
|
||
| After installation with DNX, you can run darc commands using: | ||
|
|
||
| ``` | ||
| dnx Microsoft.DotNet.Darc --help | ||
| ``` | ||
|
|
||
| Or create an alias in your shell profile for convenience: | ||
|
|
||
| **PowerShell:** | ||
| ```powershell | ||
| Set-Alias -Name darc -Value "dnx Microsoft.DotNet.Darc" | ||
| dnx --source https://pkgs.dev.azure.com/dnceng/public/_packaging/dotnet-eng/nuget/v3/index.json --prerelease Microsoft.DotNet.Darc -- get-subscriptions | ||
| ``` |
The DARC setup documentation was pointing users to a DNX-based installation flow that does not match the supported client install experience. That guidance was misleading and could lead to failed installs when followed literally.
dnx tool installand DNX alias instructions from the DARC setup docs..NET CLIflow for installingMicrosoft.DotNet.Darc.