Skip to content

add script and template to produce docs #736

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

Merged
merged 1 commit into from
Aug 20, 2015
Merged

add script and template to produce docs #736

merged 1 commit into from
Aug 20, 2015

Conversation

devigned
Copy link
Member

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.

@azuresdkci
Copy link

Can one of the admins verify this patch?

@markcowl
Copy link
Member

@azuresdkci add to whitelist


Param
(
[CmdletBinding()]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix alignment

devigned added a commit that referenced this pull request Aug 20, 2015
add script and template to produce docs
@devigned devigned merged commit 847af7c into Azure:dev Aug 20, 2015
@devigned devigned deleted the feature/docs branch August 20, 2015 22:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants