Hosted at URL: ucb-rit.github.io
Documentation for UC Berkeley Research-IT using GitHub Pages.
Using GitHub Pages allows Research-IT to have a modern, extensible workflow and user-interface / user-experience (UI / UX). However, I (Olives) strongly encourage Research-IT to move away from GitHub due to the following concerns:
Inspiration for User-interface of Docs
Look at how beautiful and user-friendly our documentation could be!
Example Markdown versions of existing Research-IT docs:
The using-r-savio page was created by making a Markdown file with content copy-and-pasted from the HTML that can be found in a browser's developer options.
The running-your-jobs page was made by a near direct copy-and-paste from the Drupal editor (select Markdown option) to GitHub Pages. Only slight editing to code snippets for job scripts using SLURM commands.
Also, can we please write in the style of:
job scripts using SLURM commands
SLURM job scripts
Reasoning: The former makes developing code and using these batch job scripts more intuitive to Savio users. It will help make it clear that non-SLURM commands / code can be included in these files. I.e. Not exclusive to SLURM commands.
This site currently uses raw Markdown without any web UI / UX development, themes, or CSS. Next steps may involve using one of the supported themes for GitHub Pages.
Issue: need a way to preview webpages made before publishing
Feature: can develop a .md template with a header, footer, and menu (etc). New pages can be made by writing content that will be inserted into the wrapping template. This will allow a modularized and stream-lined workflow.