bicep icon indicating copy to clipboard operation
bicep copied to clipboard

Create Help Page on Microsoft Learn for Bicep Warnings/Error Codes

Open stephaniezyen opened this issue 1 year ago • 4 comments

https://github.com/Azure/bicep/issues/13287#issuecomment-1936379160

As addressed in above issue, we don't have an official page on Microsoft Learn that covers all Bicep Warnings and Error Codes and should create one.

stephaniezyen avatar Feb 21 '24 21:02 stephaniezyen

Can we prioritize this?

anthony-c-martin avatar Mar 30 '24 07:03 anthony-c-martin

Here's the full list of error codes: https://github.com/Azure/bicep/blob/main/src/Bicep.Core/Diagnostics/DiagnosticBuilder.cs

I don't think we need an exhaustive list in the document - it would be good to just make a start and include the codes that we know trip people up. That way we can collect feedback on what is missing, and update accordingly.

https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/maintainability-warnings is a good example of what I think this could look like.

anthony-c-martin avatar Apr 11 '24 04:04 anthony-c-martin

@anthony-c-martin - can you review the PR - https://github.com/MicrosoftDocs/azure-docs-pr/pull/272325? Thanks!

mumian avatar Apr 18 '24 20:04 mumian

See https://github.com/MicrosoftDocs/azure-docs-pr/pull/276731 for the format.

mumian avatar May 30 '24 16:05 mumian