(DOCS) Update CLI reference and conceptual docs for v3.0.0 #672
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
michaeltlombardi
force-pushed
the
docs/main/v3-reference
branch
from
8322bb9 to
84a9cd8
Compare
michaeltlombardi
changed the title
Gijsreyn
reviewed
Mar 18, 2025
3 tasks
michaeltlombardi
force-pushed
the
docs/main/v3-reference
branch
from
69f79fe to
18a2eee
Compare
Gijsreyn
reviewed
Mar 19, 2025
Gijsreyn
reviewed
Mar 19, 2025
Gijsreyn
reviewed
Mar 19, 2025
Gijsreyn
reviewed
Mar 19, 2025
| --------------------------------------------------------------- | ||
| DesiredStateConfiguration-Preview 9PCX3HX4HZ0Z Unknown msstore | ||
| ``` | ||
|
|
There was a problem hiding this comment.
Perhaps a small remark for the users telling something like:
[!INFO]
You can use eithermsstoreorwingetas the source. When usingwinget, it leverages the.zipfile, whereasmsstoreuses the.msixbundle.
michaeltlombardi
force-pushed
the
docs/main/v3-reference
branch
from
18a2eee to
690ae7e
Compare
michaeltlombardi
force-pushed
the
docs/main/v3-reference
branch
from
690ae7e to
de65bee
Compare
SteveL-MSFT
requested changes
Apr 15, 2025
mgreenegit
reviewed
Apr 16, 2025
mgreenegit
reviewed
Apr 16, 2025
mgreenegit
reviewed
Apr 16, 2025
mgreenegit
approved these changes
Apr 16, 2025
michaeltlombardi
force-pushed
the
docs/main/v3-reference
branch
from
2073abd to
4f7cbac
Compare
SteveL-MSFT
requested changes
Apr 25, 2025
|
|
||
| ## export | ||
|
|
||
| A resource with the `export` capability supports enumerating every instance of the resource with |
There was a problem hiding this comment.
I think it's worth calling out that if no input is provided, expectation is all instances are returned, but if there is input, then that input should be used as a filter.
There was a problem hiding this comment.
This isn't currently implemented but it's the planned implementation, correct?
There was a problem hiding this comment.
Input is passed to the resource on export if provided
michaeltlombardi
force-pushed
the
docs/main/v3-reference
branch
from
2fd0aea to
939b321
Compare
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.
Co-authored-by: Steve Lee <[email protected]> Co-authored-by: Michael Greene <[email protected]>
michaeltlombardi
force-pushed
the
docs/main/v3-reference
branch
from
939b321 to
ae29420
Compare
SteveL-MSFT
approved these changes
May 1, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This changeset updates and adds reference documentation for the
3.0.0GA release of DSC.It includes:
Deferred to future PRs:
PR Context