PowerShell-Docs-DSC icon indicating copy to clipboard operation
PowerShell-Docs-DSC copied to clipboard

Published 20 hours ago • verified publisher icon MicrosoftDocs

PSDSC v3 is not DSC v3

Open gaelcolas opened this issue 2 years ago • 2 comments

Prerequisites

  • [X] Existing Issue: Search the existing issues for this repository. If there is an issue that fits your needs do not file a new one. Subscribe, react, or comment on that issue instead.
  • [X] Descriptive Title: Write the title for this issue as a short synopsis. If possible, provide context. For example, "Typo in Get-Foo cmdlet" instead of "Typo."
  • [X] Verify Version: If there is a mismatch between documentation and the module on your system, ensure that the version you are using is the same as the documentation. Check this box if they match or the issue you are reporting is not version specific.

Version

v3.0

Links

https://github.com/MicrosoftDocs/PowerShell-Docs-DSC/blob/main/dsc/docs-conceptual/dsc-3.0/overview.md

Summary

There's a conflict of ideas between what the PS Team call DSCv3 and what other teams call DSCv3 such as this doc. Someone came to the PS Discord asking for info about DSCv3 on Linux, and referring both to this doc and the last presentation from Steve about what he calls DSCv3. Which is it? Those are 2 different things.

Details

Feel free to ask me any question.

Suggested Fix

Refer to the module as PSDSCv3, and the project Steve is working on as DSCv3 Utility, or even DSCv3 engine or something...

DSC (good old one) is:

  • DSC DSL
  • DSC Resources enabled by different versions of PSDSC
  • DSC Agent (LCM)
  • DSC Pull Server
  • DSC Reporting server (or a draft of one)

Each and every DSC documentation should at least link to an explanation and definition of this, and how the DSC ecosystem relate to each of them (i.e. Machine Config).

gaelcolas avatar May 09 '23 06:05 gaelcolas

@michaeltlombardi think we could get this updated now that DSC v3 is in preview so we can get naming standards down before it becomes even more confusing?

At minimum the title PowerShell Desired State Configuration v3 overview should remove PowerShell and be Desired State Configuration v3 overview.

ThomasNieto avatar Aug 10 '23 02:08 ThomasNieto

@ThomasNieto - great catch, I've updated the docs and pushed them to live, so they should show up soon.

michaeltlombardi avatar Aug 10 '23 16:08 michaeltlombardi