search

ComputeCanada / magic_castle

Terraform modules to replicate the HPC user experience in the cloud
MIT License
124 stars 36 forks source link

use Material for MkDocs to render documentation #290

Closed boegel closed 6 months ago

boegel commented 7 months ago

These are the absolute minimal changes to render the existing documentation with Material for MkDocs, and serve the result through GitHub Pages (via https://computecanada.github.io/magic_castle, after this PR gets merged).

Other than adding the Magic Caste logo on the landing page and fixing a link to main.tf (which is required to make mkdocs build --strict happy), the existing documentation was not changed (although some changes to improve the menu and fixing broken links to section are probably a good idea before actually promoting the resulting documentation site).

A preview of what the rendered docs look like is available in my fork at https://boegel.github.io/magic_castle, which was created by merging a PR in my fork. Try the search, that by itself is a great reason to serve the existing docs via Material for MkDocs...

cmd-ntrf commented 6 months ago

It is online now! https://computecanada.github.io/magic_castle/

I had to go there

image

and select "deploy from a branch" to make it available via the github.io link.