Skip to content

docs: Add DSC documentation for PSResourceGet - #381

Draft
Gijs Reijn (Gijsreyn) wants to merge 2 commits into
MicrosoftDocs:mainfrom
Gijsreyn:dsc-psresourceget-docs
Draft

Gijs Reijn (Gijsreyn) wants to merge 2 commits into
MicrosoftDocs:mainfrom
Gijsreyn:dsc-psresourceget-docs

Conversation

@Gijsreyn

Copy link
Copy Markdown

PR Summary

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.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. 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.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 02353e1:

⚠️ Validation status: warnings

File Status Preview URL Details
powershell-gallery/docs-conceptual/powershellget/dsc/reference/psresourcelist.md ⚠️Warning View (>=powershellget-2.x) Details
powershell-gallery/docs-conceptual/powershellget/dsc/how-to/configuration-documents.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/dsc/how-to/invoke-resources.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/dsc/overview.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/dsc/reference/repository.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/toc.yml ✅Succeeded

powershell-gallery/docs-conceptual/powershellget/dsc/reference/psresourcelist.md

  • Line 439, Column 3: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.PowerShell.PSResourceGet.Get-PSResource'.

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Technical review pass

Comment on lines +77 to +78
Add the folder for the installed module version to `PATH` so that DSC can find the manifests. The
following commands add the newest installed version for the current session:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Gijs Reijn (@Gijsreyn) - I thought that the PowerShell discovery resource would pick up and find the resource automatically - is this still a required step?

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

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

I added a new section to explain it.

Comment thread powershell-gallery/docs-conceptual/powershellget/dsc/reference/psresourcelist.md Outdated
Comment thread powershell-gallery/docs-conceptual/powershellget/dsc/how-to/invoke-resources.md Outdated
@learn-build-service-prod

Copy link
Copy Markdown
Contributor

Learn Build status updates of commit 659326e:

✅ Validation status: passed

File Status Preview URL Details
powershell-gallery/docs-conceptual/powershellget/dsc/how-to/configuration-documents.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/dsc/how-to/invoke-resources.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/dsc/overview.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/dsc/reference/psresourcelist.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/dsc/reference/repository.md ✅Succeeded View (>=powershellget-2.x)
powershell-gallery/docs-conceptual/powershellget/toc.yml ✅Succeeded

For more details, please refer to the build report.

@learn-build-service-prod

Copy link
Copy Markdown
Contributor

PoliCheck Scan Report

The following report lists PoliCheck issues in PR files. Before you merge the PR, you must fix all severity-1 and severity-2 issues. 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.

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