Skip to content

Conversation

michaeltlombardi
Copy link
Contributor

PR Summary

This change drafts the conceptual documentation for guidance on how to author DSC resources from a
design perspective. It does not include any specific guidance from a code or language perspective.

Instead, it focuses on the high level concepts and on defining the resource manifest and instance JSON Schema.

This change is a mirror of the one submitted to the source repository:

To do:

  • Draft guidance for typical resource manifests
  • Draft guidance for defining a typical resource instance schema
  • Draft guidance for exporter resource manifests

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.

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 change drafts the conceptual documentation for
guidance on how to author DSC resources from a
design perspective. It does not include any specific
guidance from a code or language perspective.

Instead, it focuses on the high level concepts and on
defining the resource manifest and instance JSON Schema.

This change is a mirror of the one submitted to the
source repository:

- PowerShell/DSC#1027
Copy link

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 issues. Other issues are also a high priority. The AI Review Details column lists suggestions for either removing or replacing the terms. If you find a false positive result, mention it in a PR comment and include this text: #policheck-false-positive. This feedback helps reduce false positives in future scans.

✅ No issues found

More information about PoliCheck

Information: PoliCheck | Severity Guidance | Term
For any questions: Try searching the learn.microsoft.com contributor guides or post your question in the Learn support channel.

Copy link

Learn Build status updates of commit b1c7d43:

⚠️ Validation status: warnings

File Status Preview URL Details
dsc/docs-conceptual/dsc-3.0 ⚠️Warning Details
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/emitting-messages.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/exit-codes.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/exporter/resource-manifest.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/index.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/manifest-metadata.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/operation-invocations.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/toc.yml ✅Succeeded
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/typical/resource-instance-schema.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/resources/authoring/typical/resource-manifest.md ✅Succeeded View (dsc-3.0)
dsc/docs-conceptual/dsc-3.0/concepts/toc.yml ✅Succeeded

dsc/docs-conceptual/dsc-3.0

  • Line 0, Column 0: [Warning: folder-name-invalid-character - See documentation] Only lowercase letters, numbers, and hyphens are allowed in folder names.
  • Line 0, Column 0: [Suggestion: folder-name-incomplete - See documentation] The folder name contains an incomplete word, misspelled word, acronym, or abbreviation that is disallowed.

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.

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.

1 participant