Create chapter division in sidebar

This commit is contained in:
Spencer Bliven
2019-06-14 21:01:13 +02:00
parent 8b176ba65a
commit c0626c4884
2 changed files with 45 additions and 11 deletions

View File

@ -1,11 +1,25 @@
# Merlin 6 Documentation
# HPCE Documentation
This site documents the *Merlin 6* cluster at Paul Scherrer Institute.
Live pages are available at https://lsm-hpce.gitpages.psi.ch/merlin6.
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.
## 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:
```
@ -27,10 +41,19 @@ by Tom Johnson.
### Organization
- Sidebars are specified in `_data/sidebars/<sidebar>.yml`. Use
`sidebar: <sidebar>` in the frontmatter of a page
- Top Menu is controlled by `_data/topnav.yml`
- Documentation is organized within the `pages` directory
- Add the following frontmatter to each (Merlin6) page:
```
---
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

View File

@ -5,7 +5,7 @@ entries:
- product: Merlin 6
levels: one
folders:
- title: Documentation
- title: Introduction
output: web
folderitems:
- title: Introduction
@ -17,6 +17,13 @@ entries:
- title: Hardware And Software Description
url: /merlin6/hardware-and-software.html
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
url: /merlin6/request-account.html
output: web
@ -29,18 +36,22 @@ entries:
- title: Accessing Slurm Cluster
url: /merlin6/slurm-access.html
output: web
- title: Merlin6 Slurm
url: /merlin6/slurm.html
output: web
folderitems:
- title: Slurm Basic Commands
url: /merlin6/slurm-basics.html
output: web
- title: Slurm Configuration
url: /merlin6/slurm-configuration.html
output: web
- title: Support
output: web
folderitems:
- title: Contact
url: /merlin6/contact.html
output: web
- title: Migration From Merlin5
url: /merlin6/migrating.html
output: web
- title: Known Problems and Troubleshooting
url: /merlin6/troubleshooting.html
output: web