Update conceptual documentation for v3 GA #287

michaeltlombardi · 2025-03-04T15:11:42Z

PR Summary

Updates the documentation for the generally available 3.0.0 release of DSC.

This change:

Updates the terminology in the glossary and other conceptual documents
Updates the changelog to start over at the GA release, with the intent to keep the pre-release changelog on GitHub only.
Updates the overview to reflect the GA release and installation instructions
Drafts an initial getting started document that should be decomposed and expanded in the future - in the interests of getting a usable document in place ASAP, it covers both invoking resources and managing a configuration document.

This PR should be kept in draft until the v3 release is live and available both on GitHub and through WinGet.

This PR doesn't update the reference documentation - that will be handled in a separate PR.

This PR doesn't canonicalize style for links - that will be handled in a separate PR after the initial drafts, reorganization, and reference documentation updates are in place.

PR Checklist

Descriptive Title: This PR's title is a synopsis of the changes it proposes.
Summary: This PR's summary describes the scope and intent of the change.
Contributor's Guide: I have read the contributors guide.
Style: This PR adheres to the style guide.

sdwheeler

Some suggestions and a question

dsc/docs-conceptual/dsc-3.0/concepts/configurations.md

dsc/docs-conceptual/dsc-3.0/concepts/enhanced-authoring.md

dsc/docs-conceptual/dsc-3.0/concepts/resources.md

dsc/docs-conceptual/dsc-3.0/resources/concepts/anatomy.md

dsc/docs-conceptual/dsc-3.0/concepts/resources.md

dsc/docs-conceptual/dsc-3.0/overview.md

sdwheeler

See suggestions

dsc/docs-conceptual/dsc-3.0/get-started/index.md

This change primarily addresses the content of the conceptual documentation for v3.0.0. It also restructures the documentation and TOC in preparation for upcoming PRs to sync and expand the reference documentation.

learn-build-service-prod · 2025-03-25T22:38:25Z

Learn Build status updates of commit 37343bf:

💡 Validation status: suggestions

File	Status	Preview URL	Details
dsc/docs-conceptual/dsc-3.0/getting-started/getting-started.old.md	💡Suggestion	n/a (file deleted or renamed)	Details
.openpublishing.redirection.json	✅Succeeded	View (dsc-2.0) View (dsc-1.1) View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/changelog.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/configuration-documents/overview.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/configurations.md	✅Succeeded	n/a (file deleted or renamed)
dsc/docs-conceptual/dsc-3.0/concepts/enhanced-authoring.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/output-accessibility.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources.md	✅Succeeded	n/a (file deleted or renamed)
dsc/docs-conceptual/dsc-3.0/concepts/resources/anatomy.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/capabilities.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/instances.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/kinds.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/operations.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/overview.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/properties.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/get-started/index.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/getting-started/getting-started.md	✅Succeeded	n/a (file deleted or renamed)
dsc/docs-conceptual/dsc-3.0/glossary.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/overview.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/cli/completer/command.md	✅Succeeded	n/a (file deleted or renamed)
dsc/docs-conceptual/dsc-3.0/reference/cli/completer/index.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/cli/config/command.md	✅Succeeded	n/a (file deleted or renamed)
dsc/docs-conceptual/dsc-3.0/reference/cli/config/export.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/cli/config/get.md	✅Succeeded	View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/reference/cli/config/index.md	✅Succeeded	View (dsc-3.0)

This comment lists only the first 25 files in the pull request.

dsc/docs-conceptual/dsc-3.0/getting-started/getting-started.old.md

[Suggestion: file-not-redirected - See documentation] File dsc/docs-conceptual/dsc-3.0/getting-started/getting-started.old.md with URL /powershell/dsc/getting-started/getting-started.old was deleted without redirection. To avoid broken links, add a redirection.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

Addressed requests and updated documentation, ready for re-review.

This change primarily addresses the content of the conceptual documentation for v3.0.0. It also restructures the documentation and TOC in preparation for upcoming PRs to sync and expand the reference documentation. Co-authored-by: Mikey Lombardi (He/Him) <[email protected]>

* Update conceptual docs for v3 GA (#287) This change primarily addresses the content of the conceptual documentation for v3.0.0. It also restructures the documentation and TOC in preparation for upcoming PRs to sync and expand the reference documentation. * (MAINT) Update TOC casing (#296) --------- Co-authored-by: Mikey Lombardi (He/Him) <[email protected]>

michaeltlombardi requested a review from sdwheeler as a code owner March 4, 2025 15:11

michaeltlombardi marked this pull request as draft March 4, 2025 15:12

This comment was marked as outdated.

Sign in to view

sdwheeler requested changes Mar 4, 2025

View reviewed changes

dsc/docs-conceptual/dsc-3.0/concepts/resources.md Show resolved Hide resolved

This comment was marked as outdated.

Sign in to view

Gijsreyn reviewed Mar 14, 2025

View reviewed changes

dsc/docs-conceptual/dsc-3.0/overview.md Show resolved Hide resolved

Gijsreyn reviewed Mar 14, 2025

View reviewed changes

dsc/docs-conceptual/dsc-3.0/overview.md Outdated Show resolved Hide resolved

Gijsreyn reviewed Mar 14, 2025

View reviewed changes

dsc/docs-conceptual/dsc-3.0/overview.md Outdated Show resolved Hide resolved

sdwheeler force-pushed the v3-ga branch from b4d78ec to eb35393 Compare March 21, 2025 01:32

This comment was marked as outdated.

Sign in to view

sdwheeler reviewed Mar 21, 2025

View reviewed changes

dsc/docs-conceptual/dsc-3.0/overview.md Outdated Show resolved Hide resolved

michaeltlombardi force-pushed the v3-ga branch from 234b3c4 to 06f7316 Compare March 24, 2025 20:35

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from d32a9b1 to 4252cf2 Compare March 24, 2025 20:51

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from 4252cf2 to 29d824b Compare March 24, 2025 21:09

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from 29d824b to 84b5415 Compare March 24, 2025 21:18

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from 84b5415 to 3f249bb Compare March 24, 2025 21:31

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from 3f249bb to 1d353ea Compare March 24, 2025 22:21

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from 1d353ea to 5d650fd Compare March 24, 2025 22:28

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from 5d650fd to c7f39c8 Compare March 24, 2025 23:01

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from c7f39c8 to bc166bd Compare March 25, 2025 13:42

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from bc166bd to cc08fb9 Compare March 25, 2025 13:46

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from cc08fb9 to 0f30c5c Compare March 25, 2025 14:04

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from 0f30c5c to b16b5d5 Compare March 25, 2025 14:14

This comment was marked as outdated.

Sign in to view

michaeltlombardi force-pushed the v3-ga branch from b16b5d5 to a12b745 Compare March 25, 2025 14:58

This comment was marked as outdated.

Sign in to view

michaeltlombardi marked this pull request as ready for review March 25, 2025 15:03

This comment was marked as outdated.

Sign in to view

sdwheeler previously requested changes Mar 25, 2025

View reviewed changes

This comment was marked as outdated.

Sign in to view

Update conceptual docs for v3 GA

37343bf

This change primarily addresses the content of the conceptual documentation for v3.0.0. It also restructures the documentation and TOC in preparation for upcoming PRs to sync and expand the reference documentation.

michaeltlombardi force-pushed the v3-ga branch from 271b70b to 37343bf Compare March 25, 2025 22:37

sdwheeler merged commit f4b529f into MicrosoftDocs:main Mar 26, 2025
4 checks passed

Update conceptual documentation for v3 GA #287

Update conceptual documentation for v3 GA #287

Uh oh!

Conversation

michaeltlombardi commented Mar 4, 2025

PR Summary

PR Checklist

Uh oh!

This comment was marked as outdated.

sdwheeler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

This comment was marked as outdated.

sdwheeler left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment was marked as outdated.

learn-build-service-prod bot commented Mar 25, 2025

💡 Validation status: suggestions

dsc/docs-conceptual/dsc-3.0/getting-started/getting-started.old.md

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants