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

xWebAdministration: Move example from README.md to examples folder #485

Open
johlju opened this issue Sep 30, 2019 · 6 comments · May be fixed by #539
Open

xWebAdministration: Move example from README.md to examples folder #485

johlju opened this issue Sep 30, 2019 · 6 comments · May be fixed by #539
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 hacktoberfest See https://hacktoberfest.digitalocean.com/ in progress The issue is being actively worked on by someone.

Comments

@johlju
Copy link
Member

johlju commented Sep 30, 2019

This example https://github.com/PowerShell/xWebAdministration#registering-php should be moved to the Examples folder. Preferably in the root of the Examples folder as an end-to-end example.

Please note that examples are tested so they can be compiled.

@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 hacktoberfest See https://hacktoberfest.digitalocean.com/ help wanted The issue is up for grabs for anyone in the community. labels Sep 30, 2019
@Tuxhedoh
Copy link
Contributor

I think I'd like to take a crack at this. Is this literally just taking the example and putting it in it's own ps1 file in the examples folder? I'm assuming that you'd still want the PHP instructions on the page, with a link to the example.

@johlju
Copy link
Member Author

johlju commented Sep 30, 2019

@Tuxhedoh Yeah, just put in the root of the Examples folder. Make sure the name says something with end-to-end so we can differentiate it from the individual resource examples (that should go in separate folders mentioned in another issue).

For the text, please add a comment-based help block as seen here.
https://github.com/PowerShell/ActiveDirectoryDsc/blob/3e96da395d40c8667702b03a6b8665dc1ee35486/Examples/Resources/ADComputer/1-ADComputer_AddComputerAccount_Config.ps1#L20-L24

@johlju
Copy link
Member Author

johlju commented Sep 30, 2019

All text goes in the comment-based help block, and remove it from the README.md entirely.

@Tuxhedoh
Copy link
Contributor

What's the proper etiquette when it comes to handling multiple issues in one repo? Make one PR and resolve them all? There seems to be quite a bit of low hanging fruit in this project. I recognize with Hacktoberfest there will probably be quite a few people clamoring for the issues to get their 4 pr's.

@johlju
Copy link
Member Author

johlju commented Sep 30, 2019

Just mention in an issue that your are working on it, then you may send in one PR that resolves them all or several PR's that solves one each. Normally I personally send in a PR fixing a bunch of PR's.

I expect during October to get small PR's resolving one issue. That was my meaning with all these hacktoberfest issues. I also hope new contributors (to GitHub) feel they want to try send in their first PR too.

@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 Sep 30, 2019
@johlju johlju added help wanted The issue is up for grabs for anyone in the community. and removed in progress The issue is being actively worked on by someone. labels Oct 15, 2019
@johlju
Copy link
Member Author

johlju commented Oct 15, 2019

I have not seen a PR for this issue so I have labeled it help wanted so that anyone can pick it up.

vikingtiger added a commit to vikingtiger/xWebAdministration that referenced this issue Oct 22, 2019
@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 Oct 1, 2020
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 hacktoberfest See https://hacktoberfest.digitalocean.com/ in progress The issue is being actively worked on by someone.
Projects
None yet
2 participants