Fixed markdown formatting

Author: lipkau

.github/CONTRIBUTING.md

@@ -1,25 +1,27 @@
-# Contributing to AtlassianPS Homepage
+# Contributing to ConfluencePS
 
 Happy to see you are interested in helping.
 
-We have a comprehensive documentation on how to contribute here: **[Contributing to AtlassianPS](https://atlassianps.org/docs/contributing/)**.
+We have a comprehensive documentation on how to contribute here: **[Contributing to AtlassianPS](https://atlassianps.org/docs/Contributing/)**.
 
 But here is the gist of it once you have forked the repository:
 
-* before changing the code
+* before changing the code  
+
 ```powershell
 git clone https://github.com/<YOUR GITHUB USER>/ConfluencePS
 cd ConfluencePS
-# git checkout develop # not applicable for this repository
+git checkout develop
 git checkout -b <NAME FOR YOUR FEATURE>
 code .
 ```
 
-* after making the changes
+* after making the changes  
+
 ```powershell
 git add .
 git commit -m "<A MESSAGE ABOUT THE CHANGES>"
 git push
 ```
 
-* [Creating a Pull Request](https://help.github.com/articles/creating-a-pull-request/)
+* [create a Pull Request](https://help.github.com/articles/creating-a-pull-request/)

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,41 @@
+---
+name: Bug report
+about: Create a report to help us improve
+---
+<!-- markdownlint-disable MD002 -->
+<!-- markdownlint-disable MD041 -->
+
+## Description
+
+<!-- A clear and concise description of what the bug is. -->
+
+## Steps To Reproduce
+
+<!-- Provide a link to a live example, or an unambiguous set of steps to reproduce this bug. Include code to reproduce, if relevant -->
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+
+<!-- A clear and concise description of what you expected to happen. -->
+
+## Screenshots
+
+<!-- If applicable, add screenshots to help explain your problem. -->
+
+## Your Environment
+
+<!-- Include as many relevant details about the environment you experienced the bug in -->
+<!-- The following code snip is a recommendation. You can just paste the output here. -->
+
+> ```powershell
+> Get-Module AtlassianPS.Configuration -ListAvailable | Select Name, Version
+> $PSVersionTable
+> ```
+
+## Possible Solution
+
+<!-- Not obligatory, but suggest a fix/reason for the bug -->

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+---
+<!-- markdownlint-disable MD002 -->
+<!-- markdownlint-disable MD041 -->
+
+## Context
+
+> **Is your feature request related to a problem? Please describe.**
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
+
+## Description
+
+> **Describe the solution you'd like**
+
+<!-- A clear and concise description of what you want to happen. -->
+
+## Additional Information
+
+<!-- Add any other context or screenshots about the feature request here. -->

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,22 +1,30 @@
+<!-- markdownlint-disable MD002 -->
+<!-- markdownlint-disable MD041 -->
 <!-- Provide a general summary of your changes in the Title above -->
 
 ### Description
+
 <!-- Describe your changes in detail -->
 
 ### Motivation and Context
+
 <!-- Why is this change required? What problem does it solve? -->
 <!-- If it fixes an open issue, please link to the issue here as follows: -->
 <!-- closes #1, closes #2, ... -->
 
 ### Types of changes
+
 <!-- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
 - [ ] Breaking change (fix or feature that would cause existing functionality to change)
 
-### Checklist:
+### Checklist
+
 <!-- Go over all the following points, and put an `x` in all the boxes that apply. -->
 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
 - [ ] My code follows the code style of this project.
 - [ ] I have added Pester Tests that describe what my changes should do.
 - [ ] I have updated the documentation accordingly.

.github/PULL_REQUEST_TEMPLATE.md

@@ -86,7 +86,7 @@ A new major version! ConfluencePS has been totally refactored to introduce new f
 - Private functions are leveraged heavily to reduce repeat code
   - `Invoke-Method` is the most prominent example
 
-If you like drinking from the firehose, here's [everything we closed for 2.0], because we probably forgot to list something here. Otherwise, read on for summarized details.
+If you like drinking from the fire hose, here's [everything we closed for 2.0], because we probably forgot to list something here. Otherwise, read on for summarized details.
 
 ### Added
 
@@ -106,7 +106,7 @@ If you like drinking from the firehose, here's [everything we closed for 2.0], b
 - `Get-ConfluenceChildPage`
   - Default behavior returns only immediate child pages. Which also means...
   - Added `-Recurse` to return all pages below the given page, not just immediate child objects
-    - NOTE: Recurse is not available in on-prem installs right now, only Atlassian cloud instances
+    - NOTE: Recurse is not available in on-premise installs right now, only Atlassian cloud instances
   - `-ParentID` > `-PageID`
 - `Get-ConfluenceLabel`
   - Name used to be `Get-WikiPageLabel`

CHANGELOG.md

@@ -11,7 +11,7 @@ permalink: /module/ConfluencePS/
 
 Automate your documentation! ConfluencePS is a PowerShell module that interacts with Atlassian's [Confluence] wiki product.
 
-Need to add 100 new pages based on some dumb CSV file? Are you trying to figure out how to delete all pages labeled 'deleteme'? Are you sick of manually editing the same page every single day? ConfluencePS has you covered!
+Need to add 100 new pages based on some dumb CSV file? Are you trying to figure out how to delete all pages labeled 'deleteMe'? Are you sick of manually editing the same page every single day? ConfluencePS has you covered!
 
 ConfluencePS communicates with Atlassian's actively supported [REST API] via basic authentication. The REST implementation is the only way to interact with their cloud-hosted instances via API, and will eventually be the only way to interact with server installations.
 
@@ -43,6 +43,7 @@ Set-ConfluenceInfo -BaseURI 'https://YourCloudWiki.atlassian.net/wiki' -PromptCr
 ### Usage
 
 You can find the full documentation on our [homepage](https://atlassianps.org/docs/ConfluencePS) and in the console.
+
 ```powershell
 # Review the help at any time!
 Get-Help about_ConfluencePS
@@ -70,7 +71,7 @@ Check out our guidelines on [Contributing](https://atlassianps.org/docs/Contribu
 |Powershell Core (latest) on Ubuntu|[![Build Status](https://img.shields.io/vso/build/AtlassianPS/ConfluencePS/3/master.svg?style=for-the-badge)](https://dev.azure.com/AtlassianPS/ConfluencePS/_build/latest?definitionId=3)|
 |Powershell Core (latest) on MacOS|[![Build Status](https://img.shields.io/vso/build/AtlassianPS/ConfluencePS/3/master.svg?style=for-the-badge)](https://dev.azure.com/AtlassianPS/ConfluencePS/_build/latest?definitionId=3)|
 
-## Acknowledgments
+## Acknowledgements
 
 * Thanks to [brianbunke] for getting this module on it's feet
 * Thanks to [thomykay] for his [PoshConfluence] SOAP API module, which provided enough of a starting point to feel comfortable undertaking this project.

README.md

@@ -200,6 +200,7 @@ function Publish-GithubReleaseArtifact {
 }
 
 function Set-AppVeyorBuildNumber {
+    [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')]
     param()
 
     Assert-True { $env:APPVEYOR_REPO_NAME } "Is not an AppVeyor Job"
@@ -405,7 +406,7 @@ function Remove-Utf8Bom {
     .LINK
         https://gist.github.com/indented-automation/5f6b87f31c438f14905f62961025758b
     #>
-
+    [System.Diagnostics.CodeAnalysis.SuppressMessage('PSUseShouldProcessForStateChangingFunctions', '')]
     [CmdletBinding()]
     param (
         # The path to a file which should be updated.

Tools/BuildTools.psm1

@@ -6,6 +6,7 @@ permalink: /docs/ConfluencePS/classes/ConfluencePS.Attachment/
 # ConfluencePS.Attachment
 
 ## SYNOPSIS
+
 Defines an object for Attachments in Confluence.
 
 ## SYNTAX
@@ -17,14 +18,17 @@ New-Object -TypeName ConfluencePS.Attachment [-Property @{}]
 ```
 
 ## DESCRIPTION
+
 **fix**The `Attachment` is an object that describes Attachments in Confluence.
 
 ## CONSTRUCTORS
+
 _This class does not have a constructor._
 
 ## PROPERTIES
 
 ### Id
+
 The Id is the unique identifier of the `Attachment`.
 
 _This value can't be changed and is assigned by the server._
@@ -36,6 +40,7 @@ Default value: None
 ```
 
 ### Status
+
 The Status describes the current status of the `Attachment`.
 
 Possible values are: `current`, `trashed` and `draft`.
@@ -47,6 +52,7 @@ Default value: current
 ```
 
 ### Title
+
 The filename / Title of the `Attachment` as stored by the server.
 
 Note that this name is not unique between pages and can contain invalid characters for windows files.
@@ -58,6 +64,7 @@ Default value: None
 ```
 
 ### Filename
+
 The filename that will be used by Get-AttachmentFile.
 
 Note that this is designed to be unique as the page id is prepended to the name and invalid characters removed.
@@ -67,7 +74,9 @@ Type: String
 Required: True
 Default value: None
 ```
+
 ### MediaType
+
 The MIME media type of the `Attachment`.
 
 ```yaml
@@ -77,6 +86,7 @@ Default value: None
 ```
 
 ### FileSize
+
 The file size of the `Attachment` in bytes.
 
 ```yaml
@@ -86,6 +96,7 @@ Default value: None
 ```
 
 ### SpaceKey
+
 The Space key in where the `Attachment` is stored.
 
 ```yaml
@@ -95,6 +106,7 @@ Default value: None
 ```
 
 ### PageId
+
 The page ID in where the `Attachment` is stored.
 
 ```yaml
@@ -104,6 +116,7 @@ Default value: None
 ```
 
 ### Version
+
 Contains the information about the latest version of the `Attachment`.
 
 ```yaml
@@ -113,16 +126,19 @@ Default value: None
 ```
 
 ### URL
+
 Contains the URL under which the `Attachment` is accessible.
 
 ```yaml
 Type: String
 Required: True
 Default value: None
 ```
+
 ## METHODS
 
 ### ToString()
+
 The method for casting an object of this class to string is overwritten.
 
 When cast to string, this will return `[$Id] $Title`.

docs/en-US/classes/ConfluencePS.Attachment.md

@@ -6,6 +6,7 @@ permalink: /docs/ConfluencePS/classes/ConfluencePS.ContentLabelSet/
 # ConfluencePS.ContentLabelSet
 
 ## SYNOPSIS
+
 Defines an object for ContentLabelSets in Confluence.
 
 ## SYNTAX
@@ -17,17 +18,21 @@ New-Object -TypeName ConfluencePS.ContentLabelSet [-Property @{}]
 ```
 
 ## DESCRIPTION
+
 The `ContentLabelSet` is an object that describes the `Label`s that are assigned to a `Page`.
 
 ## REFERENCES
+
 _This class is not used by any other class._
 
 ## CONSTRUCTORS
+
 _This class does not have a constructor._
 
 ## PROPERTIES
 
 ### Page
+
 Contains the `Page` that is being described.
 
 ```yaml
@@ -37,6 +42,7 @@ Default value: None
 ```
 
 ### Labels
+
 Contains a list of `Label`s that are assigned to the `Page`.
 
 ```yaml
@@ -48,4 +54,5 @@ Default value: None
 ## METHODS
 
 ### ToString()
+
 _No behavior of casting to string is defined._