Fixed note generation

AzureAD · Nov 30, 2023 · 2966c96 · 2966c96
1 parent 51a8488
commit 2966c96
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 13 deletions.
diff --git a/build/Build-Wiki.ps1 b/build/Build-Wiki.ps1
@@ -101,6 +101,19 @@ $($description.Trim())
 
 "@
     }
+
+    # Notes
+    $notes = $help.Notes | Out-String
+    if (![string]::IsNullOrWhiteSpace($notes)) {
+        $md += @"
+## Notes
+
+$($notes.Trim())
+
+
+"@
+    }
+
     # examples
     if($help.examples.example.Count -gt 0) {
         $md += @"
@@ -128,7 +141,7 @@ $remarks
 
 "@
             }
-        } 
+        }
     }
     # Parameters
     if($help.parameters.parameter.count -gt 0) {
@@ -146,7 +159,7 @@ $remarks
             $md += @"
 ### -$($param.name.Trim())
 
-  $($param.description.Text.Trim())
+    $($param.description.Text)
 
 ``````yaml
 Type: $($param.type.name.Trim())
@@ -175,7 +188,7 @@ $($inputType)
 
 
 "@
-        }        
+        }
     }
     # result types
     if($help.returnValues.returnValue.type.name.Count -gt 0) {
@@ -192,7 +205,7 @@ $($returnValue)
 
 
 "@
-        }        
+        }
     }
     # aliases
     $aliases = $(get-alias -definition $help.Name -ErrorAction SilentlyContinue)
@@ -242,4 +255,4 @@ $($returnValue)
     }
     $md | Out-File -FilePath (Join-Path -Path $wikiPath -ChildPath "$($help.Name).md") -Force
 }
-$cmdletsmd | Out-File -FilePath (Join-Path -Path $wikiPath -ChildPath "Cmdlets.md") -Force
+$cmdletsmd | Out-File -FilePath (Join-Path -Path $wikiPath -ChildPath "Cmdlets.md") -Force
diff --git a/src/Test-MsIdCBATrustStoreConfiguration.ps1 b/src/Test-MsIdCBATrustStoreConfiguration.ps1
@@ -2,14 +2,7 @@
 .SYNOPSIS
     Test & report for common mis-configuration issues with the Entra ID Certificate Trust Store
 
-.INPUTS
-    None
-.NOTES
-    This Powershell cmdlet require Windows command line utility Certutil. This cmdlet can only be run from Windows device.
-
-    Since the CRL Distribution Point (CDP) needs to be accessible to Entra ID. It is best to run this script from outside
-    a corporate network on an internet connected Windows device.
-
+.DESCRIPTION
     The following is a list of checks performed by this cmdlet.
 
     * CertificateRevocationListUrl Format Validation Test: Checks for a correctly formatted CRL Distribution Point (CDP) URL
@@ -21,6 +14,14 @@
     * CRL Time Validity Test: Checks that the CRL being evaluated is time valid
     * Additional CRL Information: This include properties of the tested CRL including thisUpdate(Issued), nextPublish, nextUpdate(Expiry) and amount of time remaining
 
+    This Powershell cmdlet require Windows command line utility Certutil. This cmdlet can only be run from Windows device.
+
+    Since the CRL Distribution Point (CDP) needs to be accessible to Entra ID. It is best to run this script from outside
+    a corporate network on an internet connected Windows device.
+
+.INPUTS
+    None
+
 .EXAMPLE
     Test-MsIdCBATrustStoreConfiguration
 .LINK