Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

WebConfigPropertyCollection: Allow deleting single item property collections, update examples, remove duplicate resource documentation #644

Merged
merged 6 commits into from
Nov 5, 2024

Conversation

Borgquite
Copy link
Contributor

@Borgquite Borgquite commented Nov 4, 2024

Pull Request (PR) description

Add support for single item property value collections - add is already supported with the correct syntax, so have updated examples & added 'delete' support.

(NB 'Updating' a single item property value collection is pretty meaningless as there's nothing relevant to 'update' - you can only add or delete).

Also removing the duplicated resource documentation under README.md. Most resources solely rely on the Wiki, which should surely be the 'single source of truth' for resource documentation now, like for other modules?

This Pull Request (PR) fixes the following issues

Task list

  • 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).
  • Resource documentation added/updated in README.md.
  • Resource parameter descriptions added/updated in README.md, schema.mof and comment-based
    help.
  • Comment-based help added/updated.
  • Localization strings added/updated in all localization files as appropriate.
  • Examples appropriately added/updated.
  • 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 Reviewable

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88%. Comparing base (c5e65a4) to head (1f0f354).
Report is 2 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@         Coverage Diff         @@
##           main   #644   +/-   ##
===================================
  Coverage    88%    88%           
===================================
  Files        15     15           
  Lines      1952   1954    +2     
===================================
+ Hits       1726   1728    +2     
  Misses      226    226           
Files with missing lines Coverage Δ
...rtyCollection/DSC_WebConfigPropertyCollection.psm1 98% <100%> (+<1%) ⬆️

@Borgquite Borgquite changed the title WebConfigPropertyCollection: Allow deleting single item property collections, update examples WebConfigPropertyCollection: Allow deleting single item property collections, update examples, remove duplicate resource documentation Nov 4, 2024
Copy link

@dan-hughes dan-hughes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:lgtm:

@johlju.

Reviewed 3 of 6 files at r1, 6 of 6 files at r2, all commit messages.
Reviewable status: :shipit: complete! all files reviewed, all discussions resolved (waiting on @Borgquite)

@dan-hughes
Copy link

One thing I've just thought about @Borgquite, can you add a link in the README to the Wiki. e.g.

'The resource examples are also available in the WebAdministrationDsc Wiki.'

@Borgquite
Copy link
Contributor Author

@dan-hughes Already there?

The resource examples are also available in the [WebAdministration Wiki](https://github.com/dsccommunity/WebAdministrationDsc/wiki).

@dan-hughes
Copy link

@dan-hughes Already there?

The resource examples are also available in the [WebAdministration Wiki](https://github.com/dsccommunity/WebAdministrationDsc/wiki).

So it is. I went to the bottom, saw the examples and didn't look very hard after that!

Could do with cleaning up the two examples headings.

Beat me to it!

Should be good now.

@Borgquite
Copy link
Contributor Author

@dan-hughes Ah, I see what's happened - there are two Examples sections in the README file, one with, one without.

I've just merged them

@johlju johlju merged commit 76d82ae into dsccommunity:main Nov 5, 2024
10 of 11 checks passed
@Borgquite Borgquite deleted the documentationupdate branch November 6, 2024 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants