Skip to content

Commit

Permalink
update troubleshooting-ci.md, add a case of help generation (#11634)
Browse files Browse the repository at this point in the history
  • Loading branch information
isra-fel authored Apr 21, 2020
1 parent 196b9a4 commit 6f6ff45
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions documentation/troubleshoot-ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,23 @@ This means there are issues with your help files.

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

## Help generation failure (online version url)

### Message

> Online version in the header of the file is incorrect.
### Reasons

This means the online version url in the header of the help document is either incorrect or missing.

### Solution

The url should exactly match the schema `https://docs.microsoft.com/en-us/powershell/module/az.{modulename}/{cmdlet-name}`, all in lower case.

### Example
> https://docs.microsoft.com/en-us/powershell/module/az.keyvault/new-azkeyvault
## Code analysis failures

### Message
Expand Down

0 comments on commit 6f6ff45

Please sign in to comment.