Create chapter division in sidebar
This commit is contained in:
37
README.md
37
README.md
@ -1,11 +1,25 @@
|
|||||||
# Merlin 6 Documentation
|
# HPCE Documentation
|
||||||
|
|
||||||
This site documents the *Merlin 6* cluster at Paul Scherrer Institute.
|
This site documents HCPE services at Paul Scherrer Institute, particularly the *Merlin 6* cluster.
|
||||||
Live pages are available at https://lsm-hpce.gitpages.psi.ch/merlin6.
|
Live pages are available at https://lsm-hpce.gitpages.psi.ch.
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
The easiest and most reproducable way to test changes is using docker.
|
||||||
|
From the top directory, run the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
docker-compose up
|
||||||
|
```
|
||||||
|
|
||||||
|
This will start a webserver on `http://0.0.0.0:4000/`. Changes to most pages
|
||||||
|
will be automatically reflected in the website (with the exception of changes
|
||||||
|
to _config.yml, which requires restarting the webserver).
|
||||||
|
|
||||||
|
### Running locally
|
||||||
Building locally requires ruby 2.5 and bundler. To install:
|
Building locally requires ruby 2.5 and bundler. To install:
|
||||||
|
|
||||||
```
|
```
|
||||||
@ -27,10 +41,19 @@ by Tom Johnson.
|
|||||||
|
|
||||||
### Organization
|
### Organization
|
||||||
|
|
||||||
- Sidebars are specified in `_data/sidebars/<sidebar>.yml`. Use
|
- Documentation is organized within the `pages` directory
|
||||||
`sidebar: <sidebar>` in the frontmatter of a page
|
- Add the following frontmatter to each (Merlin6) page:
|
||||||
- Top Menu is controlled by `_data/topnav.yml`
|
```
|
||||||
|
---
|
||||||
|
title: Introduction
|
||||||
|
sidebar: merlin6_sidebar
|
||||||
|
permalink: /merlin6/introduction.html
|
||||||
|
---
|
||||||
|
```
|
||||||
|
- Sidebars are specified in data files, e.g. `_data/sidebars/merlin6_sidebar.yml`.
|
||||||
|
- The top menu is controlled by `_data/topnav.yml`
|
||||||
|
- News can be addin in `_posts`. Filenames must include the date.
|
||||||
|
- Lots of features still need to be configured (e.g. pdf output, tags, etc)
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
@ -5,7 +5,7 @@ entries:
|
|||||||
- product: Merlin 6
|
- product: Merlin 6
|
||||||
levels: one
|
levels: one
|
||||||
folders:
|
folders:
|
||||||
- title: Documentation
|
- title: Introduction
|
||||||
output: web
|
output: web
|
||||||
folderitems:
|
folderitems:
|
||||||
- title: Introduction
|
- title: Introduction
|
||||||
@ -17,6 +17,13 @@ entries:
|
|||||||
- title: Hardware And Software Description
|
- title: Hardware And Software Description
|
||||||
url: /merlin6/hardware-and-software.html
|
url: /merlin6/hardware-and-software.html
|
||||||
output: web
|
output: web
|
||||||
|
- title: Migrating From Merlin5
|
||||||
|
url: /merlin6/migrating.html
|
||||||
|
output: web
|
||||||
|
- title: Accessing Merlin
|
||||||
|
url: /merlin6/accessing-merlin6.html
|
||||||
|
output: web
|
||||||
|
folderitems:
|
||||||
- title: Requesting Merlin6 Accounts
|
- title: Requesting Merlin6 Accounts
|
||||||
url: /merlin6/request-account.html
|
url: /merlin6/request-account.html
|
||||||
output: web
|
output: web
|
||||||
@ -29,18 +36,22 @@ entries:
|
|||||||
- title: Accessing Slurm Cluster
|
- title: Accessing Slurm Cluster
|
||||||
url: /merlin6/slurm-access.html
|
url: /merlin6/slurm-access.html
|
||||||
output: web
|
output: web
|
||||||
|
- title: Merlin6 Slurm
|
||||||
|
url: /merlin6/slurm.html
|
||||||
|
output: web
|
||||||
|
folderitems:
|
||||||
- title: Slurm Basic Commands
|
- title: Slurm Basic Commands
|
||||||
url: /merlin6/slurm-basics.html
|
url: /merlin6/slurm-basics.html
|
||||||
output: web
|
output: web
|
||||||
- title: Slurm Configuration
|
- title: Slurm Configuration
|
||||||
url: /merlin6/slurm-configuration.html
|
url: /merlin6/slurm-configuration.html
|
||||||
output: web
|
output: web
|
||||||
|
- title: Support
|
||||||
|
output: web
|
||||||
|
folderitems:
|
||||||
- title: Contact
|
- title: Contact
|
||||||
url: /merlin6/contact.html
|
url: /merlin6/contact.html
|
||||||
output: web
|
output: web
|
||||||
- title: Migration From Merlin5
|
|
||||||
url: /merlin6/migrating.html
|
|
||||||
output: web
|
|
||||||
- title: Known Problems and Troubleshooting
|
- title: Known Problems and Troubleshooting
|
||||||
url: /merlin6/troubleshooting.html
|
url: /merlin6/troubleshooting.html
|
||||||
output: web
|
output: web
|
Reference in New Issue
Block a user