From 6f6ff45a5624b5b5fea8da0604e13a97a56ebf56 Mon Sep 17 00:00:00 2001 From: Yeming Liu Date: Tue, 21 Apr 2020 09:42:41 +0800 Subject: [PATCH] update troubleshooting-ci.md, add a case of help generation (#11634) --- documentation/troubleshoot-ci.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/documentation/troubleshoot-ci.md b/documentation/troubleshoot-ci.md index 1eb26344e532..c4daba503b8a 100644 --- a/documentation/troubleshoot-ci.md +++ b/documentation/troubleshoot-ci.md @@ -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