Skip to content

Commit 35d5a85

Browse files
Update README.md
Co-authored-by: Michael T Lombardi (He/Him) <[email protected]>
1 parent aea15ae commit 35d5a85

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,12 @@ This means that you are responsible for:
4040

4141
The existing family of [DSC modules](http://forge.puppet.com/dsc) will manage all the DSC administration for you, meaning that all you need to do is install the module and start writing code. These modules also do parameter validation, meaning that errors surface during development instead of at runtime. And the VS Code integration will show you usage documentation as you write the code. These modules are automatically imported from the PowerShell Gallery on a daily basis, so they're always up to date.
4242

43-
You should *only* use the `dsc_lite` module if either of these cases apply to you:
43+
You should *only* use the `dsc_lite` module when any of these cases apply to you:
4444

4545
* You need to use multiple versions of the same DSC resource
46-
* You need to use a DSC resource that isn't published to the [Puppet Forge](http://forge.puppet.com/dsc).
46+
* The upstream DSC Resource's implementation does not match its declared API but is usable otherwise and needed.
47+
* In this case, `dsc_lite` should be treated as a stop-gap solution until the upstream DSC Resource can be patched to fix the misimplementation.
48+
* You need to use a DSC Resource that isn't published to the [Puppet Forge](http://forge.puppet.com/dsc).
4749
* If you find a DSC Resource that hasn't been automatically imported, it's very likely due to the original DSC Resource failing schema validation. The `dsc_lite` module can get you by, but you should report the error upstream so that the original author can correct their code.
4850
* If you have custom DSC Resources, you can use the [Puppet.dsc module builder](https://github.com/puppetlabs/Puppet.Dsc) to build your own Puppet module from it.
4951

0 commit comments

Comments
 (0)