- [ ] bug report -> please search issues before submitting
- [ ] feature request
- [X] documentation issue or request
- [ ] regression (a behavior that used to work and stopped in a new release)
Minimal steps to reproduce
1) Go to readme for DataPlaneClient code generation:
gen2-sample/csharp-tsi-gen2-sample/DataPlaneClient/azure-rest-api-specs/specification/timeseriesinsights/data-plane/readme.md
2) Try to follow instructions to create the client code
Expected/desired behavior
New user is able to follow instructions and build the client
OS and Version?
Windows 10
1) When reading these instructions, at the top of the document, it says "This is the AutoRest configuration file for Azure Time Series Insights Gen2 Data Plane API.", but there is no file referenced, and no way to understand to which file it is referring. Directly above is a link to the AutoRest website, but that is not helpful in finding the config file that is needed. Where is the file, where do I put it, do I need to edit/customize it in any way, etc? These are my questions.
2) The next line references a link to "Simply Install AutoRest", but the link in this instruction is broken.
3) The instructions say to run the command "Autorest" in the folder, and below that, it mentions some global settings that are needed for Autorest. It seems like users should get their global settings correct BEFORE running this command, right?
4) There is a sentence that starts "These settings apply only when --csharp is specified on the command line.", so the question is, should we be setting this option? Why is this worded as a possible scenario? We need to know the exact steps, exact commands, options needed, etc. for this very specific case for this code. It should only be one set of steps for everyone. Why do we need to learn about all the options and scenarios for Autorest when we just want to create this one file? This is not helpful.
This issue is for a: (mark with an
x)Minimal steps to reproduce
1) Go to readme for DataPlaneClient code generation: gen2-sample/csharp-tsi-gen2-sample/DataPlaneClient/azure-rest-api-specs/specification/timeseriesinsights/data-plane/readme.md 2) Try to follow instructions to create the client code
Expected/desired behavior
OS and Version?
1) When reading these instructions, at the top of the document, it says "This is the AutoRest configuration file for Azure Time Series Insights Gen2 Data Plane API.", but there is no file referenced, and no way to understand to which file it is referring. Directly above is a link to the AutoRest website, but that is not helpful in finding the config file that is needed. Where is the file, where do I put it, do I need to edit/customize it in any way, etc? These are my questions. 2) The next line references a link to "Simply Install AutoRest", but the link in this instruction is broken. 3) The instructions say to run the command "Autorest" in the folder, and below that, it mentions some global settings that are needed for Autorest. It seems like users should get their global settings correct BEFORE running this command, right? 4) There is a sentence that starts "These settings apply only when --csharp is specified on the command line.", so the question is, should we be setting this option? Why is this worded as a possible scenario? We need to know the exact steps, exact commands, options needed, etc. for this very specific case for this code. It should only be one set of steps for everyone. Why do we need to learn about all the options and scenarios for Autorest when we just want to create this one file? This is not helpful.