3 ms·

Great that they finally start thinking about documentation which has been a shambolic experience with Azure. However it seems that they are still missing ARM te

by jnsaff2 10y ago

Great that they finally start thinking about documentation which has been a shambolic experience with Azure. However it seems that they are still missing ARM template resources documentation, they provide REST API documentation which kind of sort of helps with the ARM templates but still has a lot of things that are subtly different. So it still means hunting REST API docs to get the idea and then going to the ARM examples repo to find out how it differs.

mynameisvlad 10y ago
There's a whole bunch of ARM documentation here: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview https://docs.microsoft.com/en-us/azure/azure-resource-manage... And the schemas for practically anything you want to add with ARM are here: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services https://docs.microsoft.com/en-us/azure/azure-resource-manage... (some even have quickstart versions for you) And finally I noticed there's a template visualizer now (it was linked off of one of the ARM template pages): http://armviz.io/ http://armviz.io/
- jnsaff2 10y ago
  Thanks, the second link looked a little promising but then it just does a GitHub search. A proper documentation would list all possible resources and their descriptions with valid values. There is still nothing for ARM Resources. How CloudFormation can have an excellent documentation and ARM has bits and pieces is a bit weird. Their QuickStart templates repo is comprehensive but it has no real documentation of the parameters.
  - mynameisvlad 10y ago
    You can use the schema to figure out the valid values and descriptions for some of the values, so that might help. I agree that a technical reference would probably help since reading the schema isn't fun. Doesn't shock me that it's mostly GitHub search since most of our docs are hosted on GH: https://github.com/aspnet/Docs https://github.com/aspnet/Docs https://github.com/dotnet/docs https://github.com/dotnet/docs You can always add a request to the docs UserVoice: https://msdocs.uservoice.com/forums/364242-general-site-feedback https://msdocs.uservoice.com/forums/364242-general-site-feed... Azure also has its own docs UserVoice: https://feedback.azure.com/forums/217534-documentation https://feedback.azure.com/forums/217534-documentation
    - dend 10y ago
      Docs PM here. Thanks for the feedback, we point to the schema that is pulled directly from the product, but I agree that we can do a better job at documenting it. Will forward it to our Azure content people. PS: UserVoice is the best way to channel site feedback to us - I check it daily and open bugs based on suggestions there :)
      - mynameisvlad 10y ago
        +1 on UserVoice. My team (Application Insights) actively reads UserVoice and the MSDN forum, and I know other teams are just as proactive about reaching out to users.

by jnsaff2 10y ago

mynameisvlad 10y ago

There's a whole bunch of ARM documentation here: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-overview https://docs.microsoft.com/en-us/azure/azure-resource-manage... And the schemas for practically anything you want to add with ARM are here: https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services https://docs.microsoft.com/en-us/azure/azure-resource-manage... (some even have quickstart versions for you) And finally I noticed there's a template visualizer now (it was linked off of one of the ARM template pages): http://armviz.io/ http://armviz.io/

jnsaff2 10y ago
Thanks, the second link looked a little promising but then it just does a GitHub search. A proper documentation would list all possible resources and their descriptions with valid values. There is still nothing for ARM Resources. How CloudFormation can have an excellent documentation and ARM has bits and pieces is a bit weird. Their QuickStart templates repo is comprehensive but it has no real documentation of the parameters.
- mynameisvlad 10y ago
  You can use the schema to figure out the valid values and descriptions for some of the values, so that might help. I agree that a technical reference would probably help since reading the schema isn't fun. Doesn't shock me that it's mostly GitHub search since most of our docs are hosted on GH: https://github.com/aspnet/Docs https://github.com/aspnet/Docs https://github.com/dotnet/docs https://github.com/dotnet/docs You can always add a request to the docs UserVoice: https://msdocs.uservoice.com/forums/364242-general-site-feedback https://msdocs.uservoice.com/forums/364242-general-site-feed... Azure also has its own docs UserVoice: https://feedback.azure.com/forums/217534-documentation https://feedback.azure.com/forums/217534-documentation
  - dend 10y ago
    Docs PM here. Thanks for the feedback, we point to the schema that is pulled directly from the product, but I agree that we can do a better job at documenting it. Will forward it to our Azure content people. PS: UserVoice is the best way to channel site feedback to us - I check it daily and open bugs based on suggestions there :)
    - mynameisvlad 10y ago
      +1 on UserVoice. My team (Application Insights) actively reads UserVoice and the MSDN forum, and I know other teams are just as proactive about reaching out to users.