Skip to content
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

SqlServerDsc: Automatically document public functions on build #1770

Closed
johlju opened this issue Jul 25, 2022 · 0 comments · Fixed by #1986
Closed

SqlServerDsc: Automatically document public functions on build #1770

johlju opened this issue Jul 25, 2022 · 0 comments · Fixed by #1986
Labels
documentation The issue is related to documentation only. enhancement The issue is an enhancement request. in progress The issue is being actively worked on by someone.

Comments

@johlju
Copy link
Member

johlju commented Jul 25, 2022

The PR #1769 introduced public functions that are exported by the module. These public functions can be used directly from the command line, but the commands are also used by the DSC resources (currently resource SqlDatabasePermission).

BUt for users to use the public functions they should be documented as markdown files to the WikiSource folder so they can be published to the GitHub repository Wiki.

Suggest make a task that uses PlatyPS (there is already one that might be tweaked in Sampler), and there is script here that can be used as inspiration:
https://github.com/dsccommunity/ActiveDirectoryDsc/blob/main/source/Modules/ActiveDirectoryDsc.Common

The task should be in either Sampler or DscResource.DocGenerator - but can be be implemented here before it is moved if it is easier.

@johlju johlju changed the title SqlServerDsc: Document public functions SqlServerDsc: Automatically document public functions on build Jul 25, 2022
@johlju johlju added enhancement The issue is an enhancement request. help wanted The issue is up for grabs for anyone in the community. documentation The issue is related to documentation only. labels Jul 25, 2022
@johlju johlju added in progress The issue is being actively worked on by someone. and removed help wanted The issue is up for grabs for anyone in the community. labels Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation The issue is related to documentation only. enhancement The issue is an enhancement request. in progress The issue is being actively worked on by someone.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant