update documentating, fix PSAnalyzer warnings, fix markdownlint warnings

Author: iadgovuser1

CONTRIBUTING.md

@@ -1,3 +1,5 @@
+# Contributing
+
 All contributions to this project will be released as follows:
 
 1. If you are a U.S. government employee, then your changes are exempt from copyright in the U.S. and will be released under the [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/) [Universal license](https://creativecommons.org/publicdomain/zero/1.0/legalcode) worldwide.

DISCLAIMER.md

@@ -1,9 +1,14 @@
+# Disclaimers
+
 ## Disclaimer of Warranty
+
 This Work is provided "as is". Any express or implied warranties, including but not limited to, the implied warranties of merchantability and fitness for a particular purpose are disclaimed. In no event shall the United States Government be liable for any direct, indirect, incidental, special, exemplary or consequential damages (including, but not limited to, procurement of substitute goods or services, loss of use, data or profits, or business interruption) however caused and on any theory of liability, whether in contract, strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this Work, even if advised of the possibility of such damage.
 
-The User of this Work agrees to hold harmless and indemnify the United States Government, its agents and employees from every claim or liability (whether in tort or in contract), including attorneys' fees, court costs, and expenses, arising in direct consequence of Recipient's use of the item, including but not limited to, claims or liabilities made for injury to or death of personnel of User or third parties, damage to or destruction of property of User or third parties, infringement or other violations of intellectual property or technical data rights.
+The User of this Work agrees to hold harmless and indemnify the United States Government, its agents and employees from every claim or liability (whether in tort or in contract), including attorneys' fees, court costs, and expenses, ar
+ising in direct consequence of Recipient's use of the item, including but not limited to, claims or liabilities made for injury to or death of personnel of User or third parties, damage to or destruction of property of User or third parties, infringement or other violations of intellectual property or technical data rights.
 
 Nothing in this Work is intended to constitute an endorsement, explicit or implied, by the United States Government of any particular manufacturer's product or service.
 
 ## Disclaimer of Endorsement
+
 Reference herein to any specific commercial product, process, or service by trade name, trademark, manufacturer, or otherwise, in this Work does not constitute an endorsement, recommendation, or favoring by the United States Government and shall not be used for advertising or product endorsement purposes.

Examples/Adobe/ARMUpdate/ARMUpdateConnectivity.psm1

@@ -15,7 +15,7 @@ Import-Module -Name HttpConnectivityTester -Force
 # $connectivity | Format-List -Property Blocked,TestUrl,UnblockUrl,DnsAliases,IpAddresses,Description,Resolved,ActualStatusCode,ExpectedStatusCode
 
 # 4. save results:
-# Save-HttpConnectivity -Results $connectivity -OutputPath "$env:userprofile\Desktop" -FileName ('ARMUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))
+# Save-HttpConnectivity -Objects $connectivity -FileName ('ARMUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))
 
 Function Get-ARMUpdateConnectivity() {
     <#
@@ -72,4 +72,4 @@ Function Get-ARMUpdateConnectivity() {
     }
 
     return $results
-}
+}

Examples/Adobe/ARMUpdate/README.md

@@ -1,6 +1,6 @@
-## Adobe Reader Manager update connectivity tests
+# Adobe Reader Manager update connectivity tests
 
-### Usage
+## Usage
 
 1. Import this file: `Import-Module .\ARMUpdateConnectivity.psm1`
 1. Run one of the following:
@@ -9,18 +9,20 @@
     * `$connectivity = Get-ARMUpdateConnectivity -PerformBlueCoatLookup`
     * `$connectivity = Get-ARMUpdateConnectivity -Verbose -PerformBlueCoatLookup`
 1. Filter results: `$connectivity | Format-List -Property Blocked,TestUrl,UnblockUrl,DnsAliases,IpAddresses,Description,Resolved,ActualStatusCode,ExpectedStatusCode`
-1. Save results to a file: `Save-HttpConnectivity -Results $connectivity -OutputPath "$env:userprofile\Desktop" -FileName ('ARMUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))`
+1. Save results to a file: `Save-HttpConnectivity -Objects $connectivity -FileName ('ARMUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))`
+
+## Tested URLs
 
-### Tested URLs
 | Test URL | URL to Unblock | Description |
 | -- | -- | -- |
-| http://armmf.adobe.com | http://armmf.adobe.com | Adobe update metadata download |
-| https://armmf.adobe.com | https://armmf.adobe.com | Adobe update metadata download |
-| http://ardownload.adobe.com | http://ardownload.adobe.com | Adobe updates download |
-| https://ardownload.adobe.com | https://ardownload.adobe.com | Adobe updates download |
-| http://ardownload2.adobe.com | http://ardownload2.adobe.com | Adobe incremental updates download |
-| https://ardownload2.adobe.com| https://ardownload2.adobe.com | Adobe incremental updates download |
-| http://crl.adobe.com| http://crl.adobe.com | Adobe Certificate Revocation List |
+| <http://armmf.adobe.com> | <http://armmf.adobe.com> | Adobe update metadata download |
+| <https://armmf.adobe.com> | <https://armmf.adobe.com> | Adobe update metadata download |
+| <http://ardownload.adobe.com> | <http://ardownload.adobe.com> | Adobe updates download |
+| <https://ardownload.adobe.com> | <https://ardownload.adobe.com> | Adobe updates download |
+| <http://ardownload2.adobe.com> | <http://ardownload2.adobe.com> | Adobe incremental updates download |
+| <https://ardownload2.adobe.com> | <https://ardownload2.adobe.com> | Adobe incremental updates download |
+| <http://crl.adobe.com> | <http://crl.adobe.com> | Adobe Certificate Revocation List |
+
+## References
 
-### References
-* [Adobe Enterprise Toolkit >> Enterprise Administration Guide >> Service and Online Feature Configuration - Endpoint Configuration](https://www.adobe.com/devnet-docs/acrobatetk/tools/AdminGuide/services.html#endpoint-configuration)
+* [Adobe Enterprise Toolkit >> Enterprise Administration Guide >> Service and Online Feature Configuration - Endpoint Configuration](https://www.adobe.com/devnet-docs/acrobatetk/tools/AdminGuide/services.html#endpoint-configuration)

Examples/Adobe/README.md

@@ -1,4 +1,4 @@
-## Adobe connectivity tests
+# Adobe connectivity tests
 
 | Product / Service | File |
 | -- | -- |

Examples/Apple/MacOSUpdate/MacOSUpdateConnectivity.psm1

@@ -15,7 +15,7 @@ Import-Module -Name HttpConnectivityTester -Force
 # $connectivity | Format-List -Property Blocked,TestUrl,UnblockUrl,DnsAliases,IpAddresses,Description,Resolved,ActualStatusCode,ExpectedStatusCode
 
 # 4. save results:
-# Save-HttpConnectivity -Results $connectivity -OutputPath "$env:userprofile\Desktop" -FileName ('MacOSUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))
+# Save-HttpConnectivity -Objects $connectivity -FileName ('MacOSUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))
 
 Function Get-MacOSUpdateConnectivity() {
     <#
@@ -67,4 +67,4 @@ Function Get-MacOSUpdateConnectivity() {
     }
 
     return $results
-}
+}

Examples/Apple/MacOSUpdate/README.md

@@ -1,6 +1,6 @@
-## macOS update connectivity tests
+# macOS update connectivity tests
 
-### Usage
+## Usage
 
 1. Import this file: `Import-Module .\MacOSUpdateConnectivity.psm1`
 1. Run one of the following:
@@ -9,18 +9,20 @@
     * `$connectivity = Get-MacOSUpdateConnectivity -PerformBlueCoatLookup`
     * `$connectivity = Get-MacOSUpdateConnectivity -Verbose -PerformBlueCoatLookup`
 1. Filter results: `$connectivity | Format-List -Property Blocked,TestUrl,UnblockUrl,DnsAliases,IpAddresses,Description,Resolved,ActualStatusCode,ExpectedStatusCode`
-1. Save results to a file: `Save-HttpConnectivity -Results $connectivity -OutputPath "$env:userprofile\Desktop" -FileName ('MacOSUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))`
+1. Save results to a file: `Save-HttpConnectivity -Objects $connectivity -FileName ('MacOSUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))`
+
+## Tested URLs
 
-### Tested URLs
 | Test URL | URL to Unblock | Description |
 | -- | -- | -- |
-| https://swscan.apple.com | https://swscan.apple.com | |
-| https://swcdnlocator.apple.com | https://swcdnlocator.apple.com | |
-| https://swdownload.apple.com | https://swdownload.apple.com | |
-| https://swcdn.apple.com | https://swcdn.apple.com | |
-| https://swdist.apple.com | https://swdist.apple.com | |
+| <https://swscan.apple.com> | <https://swscan.apple.com> | |
+| <https://swcdnlocator.apple.com> | <https://swcdnlocator.apple.com> | |
+| <https://swdownload.apple.com> | <https://swdownload.apple.com> | |
+| <https://swcdn.apple.com> | <https://swcdn.apple.com> | |
+| <https://swdist.apple.com> | <https://swdist.apple.com> | |
+
+## References
 
-### References
 * [Requirements for Software Update service](https://support.apple.com/en-us/HT200149)
 * [OS X: Server addresses used by Software Update](https://support.apple.com/en-us/HT202943)
 * [OSX Apple Updates?](https://github.com/bntjah/lancache/issues/36)

Examples/Apple/README.md

@@ -1,5 +1,5 @@
-## Apple connectivity tests
+# Apple connectivity tests
 
 | Product / Service | File |
 | -- | -- |
-| [macOS updates](./MacOSUpdate/) | [MacOSUpdateConnectivity.psm1](./MacOSUpdate/MacOSUpdateConnectivity.psm1) |
+| [macOS updates](./MacOSUpdate/) | [MacOSUpdateConnectivity.psm1](./MacOSUpdate/MacOSUpdateConnectivity.psm1) |

Examples/Google/ChromeBrowser/ChromeUpdateConnectivity.psm1

@@ -15,7 +15,7 @@ Import-Module -Name HttpConnectivityTester -Force
 # $connectivity | Format-List -Property Blocked,TestUrl,UnblockUrl,DnsAliases,IpAddresses,Description,Resolved,ActualStatusCode,ExpectedStatusCode
 
 # 4. save results:
-# Save-HttpConnectivity -Results $connectivity -OutputPath "$env:userprofile\Desktop" -FileName ('ChromeUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))
+# Save-HttpConnectivity -Objects $connectivity -FileName ('ChromeUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))
 
 Function Get-ChromeUpdateConnectivity() {
     <#
@@ -74,4 +74,4 @@ Function Get-ChromeUpdateConnectivity() {
     }
 
     return $results
-}
+}

Examples/Google/ChromeBrowser/README.md

@@ -1,6 +1,6 @@
-## Chrome update connectivity tests
+# Chrome update connectivity tests
 
-### Usage
+## Usage
 
 1. Import this file: `Import-Module .\ChromeUpdateConnectivity.psm1`
 1. Run one of the following:
@@ -9,19 +9,21 @@
     * `$connectivity = Get-ChromeUpdateConnectivity -PerformBlueCoatLookup`
     * `$connectivity = Get-ChromeUpdateConnectivity -Verbose -PerformBlueCoatLookup`
 1. Filter results: `$connectivity | Format-List -Property Blocked,TestUrl,UnblockUrl,DnsAliases,IpAddresses,Description,Resolved,ActualStatusCode,ExpectedStatusCode`
-1. Save results to a file: `Save-HttpConnectivity -Results $connectivity -OutputPath "$env:userprofile\Desktop" -FileName ('ChromeUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))`
+1. Save results to a file: `Save-HttpConnectivity "$env:userprofile\Desktop" -FileName ('ChromeUpdateConnectivity_{0:yyyyMMdd_HHmmss}' -f (Get-Date))`
+
+## Tested URLs
 
-### Tested URLs
 | Test URL | URL to Unblock | Description |
 | -- | -- | -- |
-| http://redirector.gvt1.com | http://*.gvt1.com | |
-| https://redirector.gvt1.com | https://*.gvt1.com | |
-| http://update.googleapis.com/service/update2 | http://update.googleapis.com | |
-| https://update.googleapis.com/service/update2 | https://update.googleapis.com | |
-| https://clients2.google.com | https://clients2.google.com | |
-| https://clients5.google.com | https://clients5.google.com | |
-| https://tools.google.com | https://tools.google.com | |
-| http://dl.google.com | http://dl.google.com | |
+| <http://redirector.gvt1.com> | <http://*.gvt1.com> | |
+| <https://redirector.gvt1.com> | <https://*.gvt1.com> | |
+| <http://update.googleapis.com/service/update2> | <http://update.googleapis.com> | |
+| <https://update.googleapis.com/service/update2> |<https://update.googleapis.com> | |
+| <https://clients2.google.com> | <https://clients2.google.com> | |
+| <https://clients5.google.com> | <https://clients5.google.com> | |
+| <https://tools.google.com> | <https://tools.google.com> | |
+| <http://dl.google.com> | <http://dl.google.com> | |
+
+## References
 
-### References
 * [Manage Chrome updates (Windows) - Questions - What URLs are used for Chrome Browser updates?](https://support.google.com/chrome/a/answer/6350036?hl=en)

Examples/Google/README.md

@@ -1,4 +1,4 @@
-## Google connectivity tests
+# Google connectivity tests
 
 | Product / Service | File |
 | -- | -- |

Examples/Microsoft/README.md

@@ -1,4 +1,4 @@
-## Microsoft connectivity tests
+# Microsoft connectivity tests
 
 | Product / Service | File |
 | -- | -- |