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

xActiveDirectory: Resource have a requirements section (in wiki README.md) #394

Closed
johlju opened this issue Jun 25, 2019 · 5 comments · Fixed by #399
Closed

xActiveDirectory: Resource have a requirements section (in wiki README.md) #394

johlju opened this issue Jun 25, 2019 · 5 comments · Fixed by #399
Assignees
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

Comments

@johlju
Copy link
Member

johlju commented Jun 25, 2019

The resource xADComputer have a Requirements section in the README.md that is used to generate the wiki documentation. See here https://github.com/PowerShell/xActiveDirectory/blob/dev/DSCResources/MSFT_xADComputer/README.md

I suggest we add this section to the other resources README.md as well. The Requirements section is meant to list requirements for a resource, for example if the resource or a specific property can only be used on node with Windows Server 2016 and above, or AD of a specific flavor or specific configuration.

@johlju johlju changed the title xActiveDirectory: Resource have a requirements section (in Wiki) xActiveDirectory: Resource have a requirements section (in wiki README.md) Jun 25, 2019
@johlju johlju added 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. labels Jun 25, 2019
@JamesFrierson1
Copy link
Contributor

Hi @johlju I'd be happy to contribute! Just to be clear, are you interested in adding the Requirements section that states "Target machine must be running Windows Server 2008 R2 or later" to every README.md in the DSCResources folder?

@johlju
Copy link
Member Author

johlju commented Jun 25, 2019

You are very welcome to contribute this! Yes, we can add that if it is true. It is probably is true in most, right? 🤔 If you know any more requirements please add them, otherwise other PRs can complement the sections later. If you add the section without any requirements for a resource then we probably should write ‘None.’ 🤔

I think it most important that the section exist so that it is clear it just not the description that can go in that README.md

@johlju
Copy link
Member Author

johlju commented Jun 26, 2019

@JamesFrierson1 I just tried the new "read-only assignee" functionality. If you decide that you don't have time to contribute this, just un-assign yourself from this issue. But looking forward to a PR. Thank you!

@JamesFrierson1
Copy link
Contributor

Sounds good, @johlju . I created PR #399 and added the Requirements section as we discussed. I went ahead and stated very DSCResource requires Windows Server 2008 R2 or later, but if that isn't true I can go back and just write "None" like you suggested

@johlju
Copy link
Member Author

johlju commented Jun 26, 2019

@JamesFrierson1 it is probably true, if it is not for one resource, I think we let another PR resolve that. 🙂

@johlju johlju removed the help wanted The issue is up for grabs for anyone in the community. label Jun 27, 2019
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. good first issue The issue should be easier to fix and can be taken up by a beginner to learn to contribute on GitHub
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants