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

Migrate Documentation to Markdown and External Help #7

Open
5 tasks
lipkau opened this issue Jul 17, 2017 · 0 comments
Open
5 tasks

Migrate Documentation to Markdown and External Help #7

lipkau opened this issue Jul 17, 2017 · 0 comments
Labels
Area:CI Area:Documentation Area:Module Area:Repository Documentation Needed Issue:Enhancement task up-for-grabs

Comments

@lipkau
Copy link
Member

lipkau commented Jul 17, 2017

Description

In order to have a documentation that is easier to access, easier to edit and maintain, and more flexible, we shall use PlatyPS for the help of the function.
Discussion on this topic: AtlassianPS/AtlassianPS#1

Task

  • Migrate all Comment Based Help to .md files in /docs
Import-Module MyAwesomeModule
New-MarkdownHelp -Module MyAwesomeModule -OutputFolder .\docs
  • Edit the .md files (.EXAMPLE block can have more that 1 command in it)
  • Create the about_<module>
New-MarkdownAboutHelp -OutputFolder C:\Test -AboutName
  • Make AppVeyor generate the ExternalHelp file (.xml) when building
New-ExternalHelp -Path ".\docs" -OutputPath "out\platyPS\en-US"
  • Remove the Comment Based Help from all functions in the module
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area:CI Area:Documentation Area:Module Area:Repository Documentation Needed Issue:Enhancement task up-for-grabs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lipkau