Skip to content

update troubleshooting-ci.md, add a case of help generation #11634

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2020
Merged

update troubleshooting-ci.md, add a case of help generation #11634

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions documentation/troubleshoot-ci.md
View file
Open in desktop
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