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

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

Closed
johlju opened this issue Sep 30, 2019 · 5 comments · Fixed by #526
Closed

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

johlju opened this issue Sep 30, 2019 · 5 comments · Fixed by #526
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/

Comments

@johlju
Copy link
Member

johlju commented Sep 30, 2019

This example https://github.com/PowerShell/xWebAdministration#all-resources-end-to-end-scenario should be moved to the Examples folder. Preferably in the root of the Examples folder as an end-to-end example. In the description for the comment-based help it should use the text that describing the example in the README.md.

The configuration Sample_IISServerDefaults should be incorporated into the end-to-end example as best it can be. If it is not possible, then just remove it as they have individual resource examples already too.

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
@Abijith10
Copy link

What do I name the file?

@johlju
Copy link
Member Author

johlju commented Sep 30, 2019

I suggest Sample_AllResources_EndToEnd.ps1

Also, please see this example how to add a comment-based block for the descriptive text that is in the README.md.

https://github.com/PowerShell/ActiveDirectoryDsc/blob/dev/Examples/Resources/ADComputer/1-ADComputer_AddComputerAccount_Config.ps1#L20-L24

@Abijith10
Copy link

This is the description of Readme.md? I'm a bit slow on understanding it.

@johlju
Copy link
Member Author

johlju commented Sep 30, 2019

Oh my bad, there was no descriptive text in the README.md. Just add the description End to end sample for xWebAdministration to the comment-based help.

@tomlarse tomlarse mentioned this issue Oct 1, 2019
Merged
9 tasks
@johlju
Copy link
Member Author

johlju commented Oct 4, 2019

This is still up for grabs.

/cc @tomlarse

@tomlarse tomlarse mentioned this issue Oct 6, 2019
Merged
9 tasks
@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 7, 2019
johlju pushed a commit that referenced this issue Oct 8, 2019
@tomlarse @johlju
xWebAdministration: Move example to separate file (#526)
03e5963 
- Changes to xWebAdministration
  - Moved example Sample_EndToEndxWebAdministration from readme.md to a separate .ps1 in `/examples/` (issue #491).
@johlju johlju removed the in progress The issue is being actively worked on by someone. label Oct 8, 2019
gstorme pushed a commit to gstorme/xWebAdministration that referenced this issue Feb 14, 2020
@tomlarse
xWebAdministration: Move example to separate file (dsccommunity#526)
fe99249 
- Changes to xWebAdministration
  - Moved example Sample_EndToEndxWebAdministration from readme.md to a separate .ps1 in `/examples/` (issue dsccommunity#491).
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 hacktoberfest See https://hacktoberfest.digitalocean.com/
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

xWebAdministration: Move example to separate file
2 participants
@johlju @Abijith10