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

(DOCS) Update CLI reference and conceptual docs for v3.0.0 #672

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

michaeltlombardi
Copy link
Collaborator

@michaeltlombardi michaeltlombardi commented Mar 5, 2025

PR Summary

This changeset updates and adds reference documentation for the 3.0.0 GA release of DSC.

It includes:

  • Updated CLI reference
  • Updated and expanded documentation for concepts
  • Scaffold reference for built-in resources

Deferred to future PRs:

  • Reference docs for built-in resources
  • Updates to schema docs

PR Context

@michaeltlombardi michaeltlombardi changed the title (DOCS) Update reference docs for v3.0.0 (DOCS) Update CLI reference and conceptual docs for v3.0.0 Mar 17, 2025
@michaeltlombardi michaeltlombardi marked this pull request as ready for review March 17, 2025 22:15
---------------------------------------------------------------
DesiredStateConfiguration-Preview 9PCX3HX4HZ0Z Unknown msstore
```

Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps a small remark for the users telling something like:

[!INFO]
You can use either msstore or winget as the source. When using winget, it leverages the .zip file, whereas msstore uses the .msixbundle.

Prior to this change, the docs folder didn't include any conceptual
documentation, only reference documents.

This change copies existing concept docs into the folder, updates them
for GA, and adds new conceptual documentation to make it easier for
new users to learn about DSC and start using it.
This change updates the reference docs for:

- `Microsoft/OSInfo` resource
- `osinfo` CLI tool
- `Microsoft.Windows/Registry` resource
- `registry` CLI tool

These are the only resources currently documented on
the live docs site.
@michaeltlombardi michaeltlombardi force-pushed the docs/main/v3-reference branch from 690ae7e to de65bee Compare April 2, 2025 15:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants