Skip to content

Commit 6f6ff45

Browse files
authored
update troubleshooting-ci.md, add a case of help generation (#11634)
1 parent 196b9a4 commit 6f6ff45

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

documentation/troubleshoot-ci.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,23 @@ This means there are issues with your help files.
2323

2424
Regenerate MD help files [this way](development-docs/help-generation.md) and update "{{\*}}" placeholders
2525

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+
2643
## Code analysis failures
2744

2845
### Message

0 commit comments

Comments
 (0)