nag-devops / speed-hpc Goto Github PK

Hi NAG team,

I would like to propose about how the manual could be made more accessible for users by hosting the content on a web-based manual.

The manual would be written in markdown and compiled into static HTML/CSS/JS bundles by a static site generator (I recommend Rust-based mdbook) and served by a simple web server like nginx or apache2 without the need for additional configurations. I think this setup (with Apache2) would fit nicely on our server environment.

From the user's perspective, aside from the common markdown specifications, the web-based manual can accommodate sections and subsections with dynamically-linked table of contents. Code blocks are syntax highlighted and can be copied to clipboard with a button.

To improve the authoring process, we could set up Github Actions to watch for source changes then automatically compile and push static artifacts to the destination web-root folder through rsync or scp.
For demo, I have mine set up at https://users.encs.concordia.ca/~a_en201.

What I have not fully figured out is how we can automate updating the content from the Latex source to the Markdown source yet.

What do you think?

and how to leverage better the AMD GPUs

Including conversions from docker on the fly and offline