Moved large parts of the ReadMe to the Wiki #488
Conversation
|
I need some help fixing the failed tests. |
johlju
changed the title
|
Hmm, seem to be an issue with the task generating help file for public commands, but it should not care about this new markdown file - must be a bug in the task. I will look into it. |
|
So it seems the tasks is run in the wrong order. So, if you please, in the build.yaml. Can you move the task This: Lines 131 to 142 in e669ffa To this: docs:
# The meta task Generate_Wiki_Content is not used so that Linux and macOS is supported
# - Generate_Conceptual_Help # Used for DSC resources
- Create_Wiki_Output_Folder
# - Generate_Markdown_For_DSC_Resources # Used for DSC resources
- Generate_Markdown_For_Public_Commands
- Generate_External_Help_File_For_Public_Commands
- Clean_Markdown_Of_Public_Commands
- Copy_Source_Wiki_Folder
- Generate_Wiki_Sidebar
- Clean_Markdown_Metadata
- Package_Wiki_Content |
|
The build should work after the above change. There is also a similar bug in the module DscResource.DocGenerator, but that won't affect this PR. I will create an issue in DocGenerator repo to track it. |
|
Great. I'll have a go... |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #488 +/- ##
===================================
Coverage 81% 81%
===================================
Files 44 44
Lines 2328 2328
===================================
Hits 1904 1904
Misses 424 424 |
|
Yeay 👍 |
|
@johlju, I fixed some typos after the last check passed and now the checks doesn't seem to start up again.
|
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Temporary glitch in Azure DevOps probably. 🙂 |
There was a problem hiding this comment.
Reviewed 1 of 1 files at r2, 2 of 3 files at r3, 2 of 2 files at r4, all commit messages.
Reviewable status: all files reviewed, 6 unresolved discussions (waiting on @DennisL68)
Sampler/WikiSource/Getting-started.md line 824 at r4 (raw file):
`output\GCPolicyPackages\UserAmyNotPresent`. ## Commands
All these commands (se below) have documentation that should be moved to each commands comment-based help (if it is not already there). By adding this documentaton to each commands comment-based help it would automatically create wiki documentation.
Sampler/WikiSource/Getting-started.md line 1637 at r4 (raw file):
the updated statistics. ## Build Task Variables
This entire section and child sections should probably be a separate markdown file in WikiSource.
Sampler/WikiSource/Getting-started.md line 1721 at r4 (raw file):
the same name as the module. ## Tasks
Each task here should have its own markdown file in WikiSource, and each file should have a markdown metadata set to (top of the markdown file):
---
Category: Tasks
Type: Documentation
---
This would generate a Tasks category in the wiki sidebar during build.
Sampler/WikiSource/Home.md line 13 at r4 (raw file):
## Getting started See the section [[Getting started]]
This line should end with full stop (.).
Suggestion:
See the section [[Getting started]].Sampler/WikiSource/Home.md line 17 at r4 (raw file):
## Prerequisites - PowerShell 5.or higher
Suggestion:
- PowerShell 5.0 or higherSampler/WikiSource/Home.md line 19 at r4 (raw file):
- PowerShell 5.or higher The build command will download all other modules required (if you choose too) into the `RequiredModules` folder of your module project for you.
Let us remove this text. It should instead be explained (if it is not already) in the other documentation.
Code quote:
The build command will download all other modules required (if you choose too) into the `RequiredModules` folder of your module project for you.
johlju
added
waiting for code fix
Pull Request
Pull Request (PR) description
The README.md was getting pretty big so I'd like to move a large part of it to the Wiki instead
Added
Changed
Deprecated
Security
Fixed
Removed
Task list
build.ps1 -ResolveDependency).This change is