Open johlju opened 1 day ago
I think we need to skip step 4, because we want the WikiContent to be correct (what we gonna publish) in the WikiContent artifact and that is create by Package_Wiki_Content. So we need to run a task prior to Package_Wiki_Content that renames and fixes the wiki content for GitHub publishing, e.g. a task Prepare_And_Clean_WikiContent_For_GitHub_Publish
. Also maybe we shouldn't chnage the filenames when PowerShell Commands markdown are created, maybe we should have a task that renames files to use unicode hyphen before publish to GitHub.
This will result in that this task needs to be added to each repo that want to opt-in for this functionality. But might be harder to determine which files are commands and not.
Maybe we just need to assume GitHb is used for these tasks and just incoporate this into existing tasks?
Details of the scenario you tried and the problem that is occurring
GiutHub repository wiki uses the filename of the markdown file as the title in the wiki page. GitHub will automatically remove hyphens (
-
) from the file name, so a filenameVisual-Studio-Code
will end up with a page having the titleVisual Studio Code
. The problem is that the hyphen in a markdown file documentation a PowerShell commandGet-Something
is also removed so the title end up beingGet Something
.When editing pages manually in the GitHub repository wiki and renaming a file to use hyphens, the hyphen
-
is converted to the unicode equivalent‐
(U+2010).Steps to reproduce the problem
Create and push a wiki page to the repository wiki that contain hyphens.
Expected behavior
Should remove hyphen for general markdown files to use as the title, but should not remove the hyphen from PowerShell commands.
Current behavior
Remove the hyphen from PowerShell commands.
Suggested solution to the issue
#
) should be removed from markdown files by a new task. This is to avoid each page having two titles.By have two separate tasks in a meta task a maintainer can choose to not run either task by configuring build.yaml accordingly.
The operating system the target node is running
n/a
Version and build of PowerShell the target node is running
n/a
Version of the module that was used
0.12.5