Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

Gijsreyn
Copy link
Contributor

@Gijsreyn Gijsreyn commented Jul 2, 2025

PR Summary

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

PR Context

@Gijsreyn Gijsreyn force-pushed the reference-doc-sshdconfig branch from 598a6fe to e0fedee Compare July 2, 2025 14:13
@Gijsreyn Gijsreyn force-pushed the reference-doc-sshdconfig branch from e0fedee to fa1b824 Compare July 15, 2025 04:34
@Gijsreyn Gijsreyn marked this pull request as ready for review July 15, 2025 05:10
@Gijsreyn
Copy link
Contributor Author

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

@Gijsreyn Gijsreyn force-pushed the reference-doc-sshdconfig branch from adb4db3 to c6dba04 Compare July 21, 2025 23:25
Comment on lines +54 to +55
- The resource must run at least under a Windows Server 2019 or Windows 10 (build 1809)
operating system.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- The resource must run at least under a Windows Server 2019 or Windows 10 (build 1809)
operating system.
- The resource must run under a Windows Server 2019 or Windows 10 (build 1809) operating system or
later.

```

</details>

Copy link
Collaborator

Choose a reason for hiding this comment

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

Missing description for this resource property - presumably it's the full configuration as an object?

Copy link
Collaborator

Choose a reason for hiding this comment

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

The resource is only usable with export, but requires the map property to be defined, so do users need to export it with an empty object? Does the resource use the object for filtering during an export operation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@tgauth mind filling in the gap here? I couldn't quickly find it from the resource.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Missing description for this resource property - presumably it's the full configuration as an object?

Yes, exactly!

The resource is only usable with export, but requires the map property to be defined, so do users need to export it with an empty object? Does the resource use the object for filtering during an export operation?

Users do not need to export with an empty object. Schema is still a work in progress :) have an open PR that will shift to not requiring the map and simply permit additional properties

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, Tess. I'll wait for that PR to get merged and update this one.

@Gijsreyn Gijsreyn force-pushed the reference-doc-sshdconfig branch from c6dba04 to 8df2b25 Compare July 29, 2025 00:29
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.

3 participants