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

PSDSC v3 is not DSC v3 #156

Open
3 tasks done
gaelcolas opened this issue May 9, 2023 · 2 comments
Open
3 tasks done

PSDSC v3 is not DSC v3 #156

gaelcolas opened this issue May 9, 2023 · 2 comments
Labels
dsc-v3 Version - DSC v3 issue-doc-bug Issue - error in documentation

Comments

@gaelcolas
Copy link

Prerequisites

  • 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.
  • 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."
  • 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 gaelcolas added issue-doc-bug Issue - error in documentation needs-triage Waiting - Needs triage labels May 9, 2023
@ThomasNieto
Copy link

@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.

michaeltlombardi added a commit to michaeltlombardi/PowerShell-Docs-DSC that referenced this issue Aug 10, 2023
This change further clarifies the distinction and terminology to
reduce confusion about PowerShell Desired State Configuration in
DSCv3.
michaeltlombardi added a commit that referenced this issue Aug 10, 2023
This change further clarifies the distinction and terminology to
reduce confusion about PowerShell Desired State Configuration in
DSCv3.
@michaeltlombardi
Copy link
Contributor

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

@michaeltlombardi michaeltlombardi added dsc-v3 Version - DSC v3 and removed needs-triage Waiting - Needs triage labels Aug 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dsc-v3 Version - DSC v3 issue-doc-bug Issue - error in documentation
Projects
None yet
Development

No branches or pull requests

3 participants