add script and template to produce docs #736
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Get-AllCommands.ps1 and templates to produce documentation and a documentation report from the Azure and AzureResourceManager modules.
The docs tools reside in tools/Docs/Get-AllCommands and will produce an output directory there which will contain the packaged docs output as well as a set of files which will show missing documentation from each cmdlet. This initial pull request will add this into the project and can be run from the cmdline after a build to produce the needed documentation. This will need to be integrated into the build system and into the pull request verification.
We should use the output of this script to verify all new pull requests are not lowering the overall documentation coverage. We should also use this script to produce documentation on release builds to provide to the content development team so that they are able to use the documentation to quickly update web published docs such as MSDN.
Thank you goes out to Jon Geller on the content team for his assistance in developing the script.