https://github.com/mattbixley/eri-support-docs

eri-support-docs
https://github.com/mattbixley/eri-support-docs

access cluster compute eri slurm

Last synced: about 1 year ago
JSON representation

eri-support-docs

• Host: GitHub
• URL: https://github.com/mattbixley/eri-support-docs
• Owner: MattBixley
• Created: 2024-10-11T02:42:22.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-04-01T02:08:19.000Z (about 1 year ago)
• Last Synced: 2025-06-13T11:03:21.987Z (about 1 year ago)
• Topics: access, cluster, compute, eri, slurm
• Language: HTML
• Homepage: https://mattbixley.github.io/eri-support-docs/
• Size: 25.3 MB
• Stars: 2
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/CONTRIBUTING.md

Awesome Lists containing this project

README

          
# eRI Support Documentation

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/nesi/support-docs?quickstart=1)

[![Deploy to gh-pages](https://github.com/MattBixley/eri-support-docs/actions/workflows/deploy.yml/badge.svg?branch=main&event=deployment_status)](https://github.com/MattBixley/eri-support-docs/actions/workflows/deploy.yml)

This repository contains the sources files for the eRI support documentation. Functionality sourced from the NeSI support pages setup.

Rendered pages are visible at [https://mattbixley.github.io/eri-support-docs/](https://mattbixley.github.io/eri-support-docs/).

## Contents

The repository is organised using the following folders:

- `checks` : scripts intended to be run by CI,

- `docs`: markdown files, structure determines categories and sections[^1],

- `docs/assets`: non-template related files, e.g. images,

- `overrides`: theme overides or extensions for page templates.

- `overrides/partials`: Overrides and extensions for sub components.

[^1]: A section or category can be replaced by an `index.md` file, this will replace the default nav with a page.

## Developer Documentation

Following pages contain information to help maintain the documentation:

- See [contributing](https://nesi.github.io/support-docs/CONTRIBUTING) ([local version](docs/CONTRIBUTING.md)), to learn how to you can contribute.

- See [formatting](https://nesi.github.io/support-docs/FORMAT), for examples of markdown syntax.

- See [create a new page](https://nesi.github.io/support-docs/NEWPAGE), for general principles to consider when writing pages.

- See [macros](https://nesi.github.io/support-docs/MACROS), for `mkdocs-macros-plugin` environment.

- See [checks](checks/README.md), for information on quality assurance tests.

- See [workflows](.github/workflows/README.md), for information on CI workflows.

## Viewing PR Branches

![Demo Site](https://github.com/CallumWalley/support-docs-dev/actions/workflows/deploy.yml/badge.svg)

Deployments of open pull requests can be viewed at [https://callumwalley.github.io/support-docs-dev/NAME-OF-BRANCH](https://callumwalley.github.io/support-docs-dev/)

## Theme

We are using the [mkdocs material theme](https://squidfunk.github.io/mkdocs-material/).

## Analyics

The site uses [Google analytics](https://analytics.google.com/analytics/web/#/p424742084). You will need to ask a google workspace admin to add you to the project.

## Migration

Migration of the Zendesk documentation is done using our [migration pipeline (NeSI internal GitLab](https://git.hpcf.nesi.org.nz/cwal219/migratedocs).

Any one off filters (e.g. don't need to be checked every time, just when converting from ZD) should go there.