File tree Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Expand file tree Collapse file tree 1 file changed +17
-0
lines changed Original file line number Diff line number Diff line change @@ -23,6 +23,23 @@ This means there are issues with your help files.
23
23
24
24
Regenerate MD help files [ this way] ( development-docs/help-generation.md ) and update "{{\* }}" placeholders
25
25
26
+ ## Help generation failure (online version url)
27
+
28
+ ### Message
29
+
30
+ > Online version in the header of the file is incorrect.
31
+
32
+ ### Reasons
33
+
34
+ This means the online version url in the header of the help document is either incorrect or missing.
35
+
36
+ ### Solution
37
+
38
+ The url should exactly match the schema ` https://docs.microsoft.com/en-us/powershell/module/az.{modulename}/{cmdlet-name} ` , all in lower case.
39
+
40
+ ### Example
41
+ > https://docs.microsoft.com/en-us/powershell/module/az.keyvault/new-azkeyvault
42
+
26
43
## Code analysis failures
27
44
28
45
### Message
You can’t perform that action at this time.
0 commit comments