Skip to content

docs: Add reference documentation for Microsoft.OpenSSH.SSHD/Windows - #934

Open
Gijs Reijn (Gijsreyn) wants to merge 17 commits into
PowerShell:mainfrom
Gijsreyn:reference-doc-sshdconfig
Open

docs: Add reference documentation for Microsoft.OpenSSH.SSHD/Windows#934
Gijs Reijn (Gijsreyn) wants to merge 17 commits into
PowerShell:mainfrom
Gijsreyn:reference-doc-sshdconfig

Conversation

@Gijsreyn

Copy link
Copy Markdown
Collaborator

PR Summary

As part of #665, this PR adds reference documentation for the Microsoft.OpenSSH.SSHD/Windows resource.

PR Context

@Gijsreyn
Gijs Reijn (Gijsreyn) marked this pull request as ready for review July 15, 2025 05:10
@Gijsreyn

Copy link
Copy Markdown
Collaborator Author

Hi Tess Gauthier (@tgauth), I saw #907 got merged and thought of creating some reference documentation. Do you mind for a review :)?

Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md Outdated
Copilot AI review requested due to automatic review settings May 7, 2026 02:16
@Gijsreyn
Gijs Reijn (Gijsreyn) force-pushed the reference-doc-sshdconfig branch from 3509e6b to 40d6808 Compare May 7, 2026 02:16

Copilot AI left a comment

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.

Pull request overview

Adds reference documentation under docs/reference/resources for the built-in OpenSSH DSC resources, intended to support issue #665 (“Document built-in resources”).

Changes:

  • Adds a new reference page and example for Microsoft.OpenSSH.SSHD/Windows.
  • Adds a new reference page for Microsoft.OpenSSH.SSHD/sshd_config.
  • Adds (but currently leaves empty) an sshd_config example page referenced from the new index.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated 17 comments.

File Description
docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md New reference doc for the Windows OpenSSH “windows-global” resource (default shell settings).
docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/examples/configure-default-shell-powershell.md New example showing how to set the default shell to Windows PowerShell.
docs/reference/resources/Microsoft/OpenSSH/SSHD/sshd_config/index.md New reference doc for the sshd_config resource (but currently mismatches actual resource schema/capabilities).
docs/reference/resources/Microsoft/OpenSSH/SSHD/sshd_config/examples/export-openssh-configuration.md Example file referenced by the docs, but currently empty.

Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md Outdated
Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md
Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md Outdated
Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md
Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md Outdated
Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md Outdated
Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/Windows/index.md Outdated
Comment thread docs/reference/resources/Microsoft/OpenSSH/SSHD/sshd_config/index.md Outdated
@Gijsreyn
Gijs Reijn (Gijsreyn) force-pushed the reference-doc-sshdconfig branch from fc9176a to 3cc2e29 Compare May 7, 2026 14:48
@Gijsreyn Gijs Reijn (Gijsreyn) changed the title Add reference documentation for Microsoft.OpenSSH.SSHD/Windows docs: Add reference documentation for Microsoft.OpenSSH.SSHD/Windows May 10, 2026
@Gijsreyn

Copy link
Copy Markdown
Collaborator Author

Tess Gauthier (@tgauth) - I totally missed your comments, but they should be resolved now. Can you have one final look 🤞?

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.

4 participants