Website for hosted documentation

[Tiberriver256]

If we create a branch called gh-pages index.html from that branch will be served at http://PowerShell.github.io/Polaris which would be sweet

• [x] Intro to Polaris / what is Polaris?
• [x] Getting started guide
• [ ] Full guide on Routing (similar to here)
• [ ] Simple route tester similar to here for help on making the routes and seeing what parameters come through
• [x] Leverage as much of of the PowerShell based documentation as possible through automation. Markdown to HTML? Should we write about_.help.txt files for everything above except for the route tester and auto-convert them to markdown / HTML?
• [ ] Docs should be automatically updated as part of the release cycle

I'm thinking that rather than even worry about converting from markdown to HTML we let Github do that for us with the Jekyll framework. I'll see if I can work up a sample site in my repo for you to look at.

Created from #135

[Tiberriver256]

Hey @tylerl0706,

I got something started on this. We would have to create a gh-pages branch before I can start a WIP Pull Request but you can check out what I have to start here:

https://tiberriver256.github.io/Polaris

The theme I borrowed almost entirely from Liquid Templates so we might want to change things up a bit but I thought it was a nice layout to start from. The API documentation is just markdown converted by Github Pages using Jekyll templating and was generated using the following PlatyPS command:

Get-Command -Module Polaris | foreach { 
New-MarkdownHelp -Command $_ -OnlineVersionUrl "http://tiberriver256.github.io/Polaris/docs/api/$($_.Name).html" -Metadata @{layout="default";title=$_.Name;type="api"
} -OutputFolder .\docs\api  }

The source for the entire site is at: https://github.com/tiberriver256/polaris/tree/gh-pages

[TylerLeonhardt]

This. is. soooooooo slick. I really like it! I so long as we can script updating the branch from when we update help, I'm game!

[TylerLeonhardt]

send that PR dude! :smile:

[Tiberriver256]

I don't have rights to manage branches on the main repo here. I think you'll have to create the gh-pages branch and then I can get the PR started.

[TylerLeonhardt]

https://github.com/PowerShell/Polaris/tree/gh-pages

[Tiberriver256]

Checked off one item on the list and the site is live! https://powershell.github.io/Polaris/

[TylerLeonhardt]

I'm thinking I could use an Azure Container Instance to host a Polaris server example 🤔

[Tiberriver256]

That would be cool!