cmdlet documentation

[timoline]

Cmdlet documentation should be very easy now to add

https://github.com/PowerShell/platyPS

[raandree]

There is a lack of time on my side to cover this. It would be great if the community could step in here.

[Sup3rlativ3]

I would be willing to help here. I don't know C but I've had a look at some of the files such as Add-NTFSAccess and can follow along.

• Are there some guidlines you would like followed or just the standard PS format?
• Do you want the help just in the cmdlet or would you like a wiki here/readthedocs?
• Do you have any other points/requests for this?

[raandree]

@Sup3rlativ3, thanks for any time you can spare on this!

@nyanhp has updated the help for AutomatedLab with "Read the Docs" which moves the help to a completely new level. I was not following this change but from what I have understand

• The help is just written in markdown
• The markdown files are published somehow using ReadTheDocs
• When building AL, we use PlatyPS to create "-help.xml" files

This seems to be the best way dealing with help.

@nyanhp, would you still do the same?

[aafksab]

I just submitted a pull request for the auto-generated markup files in ./docs
They are missing some data, and I will update as I learn more about this module

[Sup3rlativ3]

@nyanhp Can you please confirm if the above process by @raandree is still the preferred method?

[Sup3rlativ3]

Any more info on this guys?

[Sup3rlativ3]

I've noticed that my PR was committed!

Was everything as you liked or is there something I can adjust?

I'd also like to give permission to the RTD page to @raandree if that's possible or would you like to change the setup to point to another setup you create?