Azure / azure-sdk-for-net

This repository is for active development of the Azure SDK for .NET. For consumers of the SDK we recommend visiting our public developer docs at https://learn.microsoft.com/dotnet/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-net.
MIT License
5.23k stars 4.58k forks source link

[Issue] TypeSpec DPG onboarding document improvement #35235

Open raych1 opened 1 year ago

raych1 commented 1 year ago

Information

I follow the onboarding document and these are some gaps to fill.

  1. AzureSDKGeneration_Prerequistites.md Prerequisite of installation part: should select azure development workload when install vs2022.

  2. AzureSDKPackage_Setup.md Step of creating sdk package, currently dotnet sdk 7 doesn't work. The workaround is to use dotnet sdk 6. The step needs to mention dotnet version in global.json should be updated to 6.x.

  3. AzureSDKCodeGeneration_DataPlane_QuickStart Below error is reported when run dotnet build /t:GenerateCode.

    
    Copy-Item: /home/raychen/repos/github/raych1/azure-sdk-for-net/eng/common/scripts/TypeSpec-Project-Sync.ps1:23:5
      Line |
        23 |      Copy-Item -Path $source -Destination $dest -Recurse -Force
           |      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
           | Cannot find path
           | '/home/raychen/repos/github/raych1/sparse-spec/Azure.AI.AnomalyDetector/home/raychen/repos/github/azure-rest-api-specs/specification/cognitiveservices/AnomalyDetector' because it does not exist.

/home/raychen/.nuget/packages/microsoft.azure.autorest.csharp/3.0.0-beta.20230326.1/buildMultiTargeting/Microsoft.Azure.AutoRest.CSharp.targets(55,5): error MSB3073: The command "pwsh -NoProfile -NonInteractive -executionpolicy Unrestricted -File /home/raychen/repos/github/raych1/azure-sdk-for-net/sdk/anomalyDetector/Azure.AI.AnomalyDetector/src/../../../../eng/common/scripts/TypeSpec-Project-Sync.ps1 /home/raychen/repos/github/raych1/azure-sdk-for-net/sdk/anomalyDetector/Azure.AI.AnomalyDetector/src/.." exited with code 1. [/home/raychen/repos/github/raych1/azure-sdk-for-net/sdk/anomalyDetector/Azure.AI.AnomalyDetector/src/Azure.AI.AnomalyDetector.csproj]

chunyu3 commented 1 year ago

@raych1 For #3, Can you share your env? I cannot reproduce locally. Thanks

raych1 commented 1 year ago

Added another PR for the doc update. https://github.com/Azure/azure-sdk-tools/pull/5888

raych1 commented 1 year ago

@raych1 For #3, Can you share your env? I cannot reproduce locally. Thanks

I synced with Crystal and fixed issue #3 locally which was caused by mis-configure the path as absolute path in tsplocation.yaml.