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.

Sign up for GitHub

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

Jump to bottom

Move resource documentation to Wiki #101

Open
johlju opened this issue Jul 16, 2022 · 0 comments
Open

Move resource documentation to Wiki #101

johlju opened this issue Jul 16, 2022 · 0 comments
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub help wanted The issue is up for grabs for anyone in the community.

Comments

@johlju
Copy link
Member

johlju commented Jul 16, 2022

The manual documentation in the root README.md should be moved to the schema MOF files and individual resource README.md's to automatically generate documentation. There must be a README.md in each resource folder for wiki documentation to be generated, see example https://github.com/dsccommunity/FailoverClusterDsc/blob/main/source/DSCResources/DSC_Cluster/README.md.
@johlju johlju changed the title Maove resource documentation to Wiki Move resource documentation to Wiki Jul 16, 2022
@johlju johlju mentioned this issue Jul 16, 2022
Closed
@johlju johlju added help wanted The issue is up for grabs for anyone in the community. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub documentation The issue is related to documentation only. labels Jul 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation The issue is related to documentation only. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub help wanted The issue is up for grabs for anyone in the community.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@johlju