LME icon indicating copy to clipboard operation
LME copied to clipboard

Create GitHub Pages for LME documentation

Open mitchelbaker-cisa opened this issue 1 year ago • 2 comments

Is your feature request related to a problem? Please describe.

We want to create a website for hosting LME documentation, here are some examples:

  • https://malcolm.fyi/
  • http://cisagov.github.io/scubagear

Describe the solution you'd like https://docs.github.com/en/pages/quickstart doesn't have all the information we need, but it's a good start context wise.

  1. Enable GitHub Pages in the LME repository, point it to main
  2. Create _config.yml in root directory of LME
  3. We already have /docs along with subdirectories for our documentation which is good, we can reference these existing files
  4. Automate deployment to GitHub Pages (https://roelofjanelsinga.com/articles/how-to-set-up-automatically-deploy-website-github-pages/)
  5. Coordinate with Federal team on custom domain name (optional)

mitchelbaker-cisa avatar Dec 18 '24 17:12 mitchelbaker-cisa

Will provide examples of what documentation via a seperate repo will look like.

tylmorr-snl avatar Apr 09 '25 16:04 tylmorr-snl

Link to LME Docs https://cisagov.github.io/lme-docs/

NVivero avatar Jul 03 '25 01:07 NVivero