gaelcolas / Sampler

Module template with build pipeline and examples, including DSC elements.

MIT License

171 stars 42 forks source link

Moved large parts of the ReadMe to the Wiki #488

Open DennisL68 opened 3 months ago

DennisL68 commented 3 months ago

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

Gettings-started.md in the Wiki folder [closes #487]

Changed

Getting started video updated [closes #487]

Deprecated

Security

Fixed

Removed

Task list

[ ] The PR represents a single logical change. i.e. Cosmetic updates should go in different PRs.
[x] Added an entry under the Unreleased section of in the CHANGELOG.md as per format.
[ ] Local clean build passes without issue or fail tests (build.ps1 -ResolveDependency).
[x] Documentation added/updated in README.md.
[x] Documentation added/updated in the Wiki.
[ ] Comment-based help added/updated.
[ ] Localization strings added/updated in all localization files as appropriate.
[ ] Unit tests added/updated. See DSC Community Testing Guidelines.
[ ] Integration tests added/updated (where possible). See DSC Community Testing Guidelines.
[ ] New/changed code adheres to DSC Community Style Guidelines.

This change is

DennisL68 commented 3 months ago

I need some help fixing the failed tests. I didn't touch any code :)

johlju commented 3 months ago

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.

johlju commented 3 months ago

So it seems the tasks is run in the wrong order. So, if you please, in the build.yaml. Can you move the task Copy_Source_Wiki_Folder so that is is before the task Generate_Wiki_Sidebar.

This: https://github.com/gaelcolas/Sampler/blob/e669ffae8f8cdf07a4e3e2f0361c078aa74d1eff/build.yaml#L131-L142

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

johlju commented 3 months ago

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.

DennisL68 commented 3 months ago

Great. I'll have a go...

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 81%. Comparing base (e669ffa) to head (e3f64b7).

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/gaelcolas/Sampler/pull/488/graphs/tree.svg?width=650&height=150&src=pr&token=xHbQB1FHYN&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gael)](https://app.codecov.io/gh/gaelcolas/Sampler/pull/488?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Gael) ```diff @@ Coverage Diff @@ ## main #488 +/- ## =================================== Coverage 81% 81% =================================== Files 44 44 Lines 2328 2328 =================================== Hits 1904 1904 Misses 424 424 ```

DennisL68 commented 3 months ago

Yeay 👍

DennisL68 commented 3 months ago

@johlju, I fixed some typos after the last check passed and now the checks doesn't seem to start up again.

johlju commented 3 months ago

/azp run

azure-pipelines[bot] commented 3 months ago

Azure Pipelines successfully started running 1 pipeline(s).

johlju commented 3 months ago

... and now the checks doesn't seem to start up again.

Temporary glitch in Azure DevOps probably. 🙂