Handles dashes in documentation in repository Wiki

[johlju]

Pull Request (PR) description

Removed

• Removed build.psd1 as it is no longer required to build the project.

Added

• Added private function ConvertTo-WikiSidebarLinkName that converts a name to a format suitable for use as a Wiki sidebar link.
• New tasks:
  • Prepare_Markdown_FileNames_For_GitHub_Publish - This task will prepare the markdown file names for publishing to the GitHub Wiki by replacing hyphens with spaces and converting Unicode hyphens to standard hyphens. It can be controlled by parameter ReplaceHyphen in the task, which defaults to $true.
  • Clean_WikiContent_For_GitHub_Publish - This task will remove the top level header from any markdown file where the top level header equals the filename (converting Unicode hyphen to ASCII hyphen before comparison). It can be controlled by parameter RemoveTopLevelHeader in the task, which defaults to $true.

Changed

• New-GitHubWikiSidebar
  • Replaces ASCII hyphens for the Wiki sidebar.
  • Replaces Unicode hyphens with standard hyphens for the Wiki sidebar.
• Task Generate_Wiki_Content
  • Now calls Prepare_Markdown_FileNames_For_GitHub_Publish after the markdown files and external help file for command help has been generated.
  • Now calls Clean_WikiContent_For_GitHub_Publish as the last step to remove the top level header from any markdown file where the top level header equals the filename.
• Task Generate_Markdown_For_Public_Commands
  • Verbose output of the markdown files that was created.

This Pull Request (PR) fixes the following issues

• Fixes #156

Task list

• [x] Added an entry to the change log under the Unreleased section of the file CHANGELOG.md. Entry should say what was changed and how that affects users (if applicable), and reference the issue being resolved (if applicable).
• [x] Documentation added/updated in README.md.
• [x] Comment-based help added/updated.
• [ ] Localization strings added/updated in all localization files as appropriate.
• [x] Examples appropriately added/updated.
• [ ] Unit tests added/updated. See DSC Community Testing Guidelines.
• [ ] Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
• [x] New/changed code adheres to DSC Community Style Guidelines.

---

This change is 

[codecov[bot]]

Codecov Report

Attention: Patch coverage is 78.66667% with 16 lines in your changes missing coverage. Please review.

Project coverage is 94%. Comparing base (8dad542) to head (1d247c8). Report is 4 commits behind head on main.

Files with missing lines	Patch %	Lines
...sks/Clean_WikiContent_For_GitHub_Publish.build.ps1	70%	9 Missing :warning:
...re_Markdown_Filenames_For_GitHub_Publish.build.ps1	77%	6 Missing :warning:
source/tasks/Generate_Wiki_Content.build.ps1	0%	1 Missing :warning:

Additional details and impacted files

[](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) ```diff @@ Coverage Diff @@ ## main #159 +/- ## =================================== - Coverage 95% 94% -1% =================================== Files 65 70 +5 Lines 1251 1321 +70 =================================== + Hits 1189 1244 +55 - Misses 62 77 +15 ``` | [Files with missing lines](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity) | Coverage Δ | | |---|---|---| | [source/Private/ConvertTo-WikiSidebarLinkName.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2FPrivate%2FConvertTo-WikiSidebarLinkName.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvQ29udmVydFRvLVdpa2lTaWRlYmFyTGlua05hbWUucHMx) | `100% <100%> (ø)` | | | [...ask.Clean\_WikiContent\_For\_GitHub\_Publish.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2FPrivate%2FTask.Clean_WikiContent_For_GitHub_Publish.build.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvVGFzay5DbGVhbl9XaWtpQ29udGVudF9Gb3JfR2l0SHViX1B1Ymxpc2guYnVpbGQucHMx) | `100% <100%> (ø)` | | | [...re\_Markdown\_Filenames\_For\_GitHub\_Publish.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2FPrivate%2FTask.Prepare_Markdown_Filenames_For_GitHub_Publish.build.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1ByaXZhdGUvVGFzay5QcmVwYXJlX01hcmtkb3duX0ZpbGVuYW1lc19Gb3JfR2l0SHViX1B1Ymxpc2guYnVpbGQucHMx) | `100% <100%> (ø)` | | | [source/Public/New-GitHubWikiSidebar.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2FPublic%2FNew-GitHubWikiSidebar.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL1B1YmxpYy9OZXctR2l0SHViV2lraVNpZGViYXIucHMx) | `100% <100%> (ø)` | | | [...ks/Generate\_Markdown\_For\_Public\_Commands.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2Ftasks%2FGenerate_Markdown_For_Public_Commands.build.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL3Rhc2tzL0dlbmVyYXRlX01hcmtkb3duX0Zvcl9QdWJsaWNfQ29tbWFuZHMuYnVpbGQucHMx) | `84% <100%> (+1%)` | :arrow_up: | | [source/tasks/Generate\_Wiki\_Content.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2Ftasks%2FGenerate_Wiki_Content.build.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL3Rhc2tzL0dlbmVyYXRlX1dpa2lfQ29udGVudC5idWlsZC5wczE=) | `0% <0%> (ø)` | | | [...re\_Markdown\_Filenames\_For\_GitHub\_Publish.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2Ftasks%2FPrepare_Markdown_Filenames_For_GitHub_Publish.build.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL3Rhc2tzL1ByZXBhcmVfTWFya2Rvd25fRmlsZW5hbWVzX0Zvcl9HaXRIdWJfUHVibGlzaC5idWlsZC5wczE=) | `77% <77%> (ø)` | | | [...sks/Clean\_WikiContent\_For\_GitHub\_Publish.build.ps1](https://app.codecov.io/gh/dsccommunity/DscResource.DocGenerator/pull/159?src=pr&el=tree&filepath=source%2Ftasks%2FClean_WikiContent_For_GitHub_Publish.build.ps1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dsccommunity#diff-c291cmNlL3Rhc2tzL0NsZWFuX1dpa2lDb250ZW50X0Zvcl9HaXRIdWJfUHVibGlzaC5idWlsZC5wczE=) | `70% <70%> (ø)` | |