diff --git a/docs/data-transfer.md b/docs/data-transfer.md index 0fff9c6..3b65e87 100644 --- a/docs/data-transfer.md +++ b/docs/data-transfer.md @@ -1 +1,3 @@ -# Data Transfer +--- +title: Data Transfer +--- diff --git a/docs/franklin/resources.md b/docs/franklin/resources.md index e69de29..e0e3e82 100644 --- a/docs/franklin/resources.md +++ b/docs/franklin/resources.md @@ -0,0 +1,3 @@ +--- +title: Resources +--- diff --git a/docs/franklin/scheduling.md b/docs/franklin/scheduling.md index 4903da2..62d522f 100644 --- a/docs/franklin/scheduling.md +++ b/docs/franklin/scheduling.md @@ -1,3 +1,6 @@ +--- +title: Job Scheduling +--- ## Partitions diff --git a/docs/franklin/storage.md b/docs/franklin/storage.md index 00e552e..9d358ff 100644 --- a/docs/franklin/storage.md +++ b/docs/franklin/storage.md @@ -1,3 +1,7 @@ +--- +title: Storage +--- + ## Home Directories All users are allocated 20GB of storage for their home directory. diff --git a/docs/index.md b/docs/index.md index c690c5f..8e4608e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,6 @@ -# Documentation Overview +--- +title: Documentation Overview +--- Welcome to the High-Performance Computing Core Facility (HPCCF) Documentation Site. These pages are intended to be a how-to for commonly asked questions about resources supported by the UC Davis High-Performance Computing Core Facility. @@ -46,4 +48,4 @@ This site is written in markdown using [MkDocs](https://daringfireball.net/proje - [HPCCF home page](https://hpc.ucdavis.edu) - [Research Computing at UC Davis](https://researchcomputing.ucdavis.edu) -- [UC Davis DataLab](https://datalab.ucdavis.edu) \ No newline at end of file +- [UC Davis DataLab](https://datalab.ucdavis.edu) diff --git a/docs/scheduler/commands.md b/docs/scheduler/commands.md index 5bdab13..1d73f43 100644 --- a/docs/scheduler/commands.md +++ b/docs/scheduler/commands.md @@ -1,4 +1,6 @@ -# Jobs +--- +title: Slurm Commands +--- After [logging in to a cluster](../general/access.md), your session exists on the **head node**: a single, less powerful computer that serves as the gatekeeper to the rest of the cluster. @@ -274,4 +276,4 @@ c-8-58 1 low* idle 256 2:64:2 100000 0 1 ``` This view gives the nodes' socket, core, and thread configurations, their RAM, and the feature list, which you can read about in the [**Resources**](resources.md#features) section. Try `man scontrol` or `man sinfo`, or visit the official docs -for [`scontrol`](https://slurm.schedmd.com/scontrol.html) and [`sinfo`](https://slurm.schedmd.com/sinfo.html), for more options. \ No newline at end of file +for [`scontrol`](https://slurm.schedmd.com/scontrol.html) and [`sinfo`](https://slurm.schedmd.com/sinfo.html), for more options. diff --git a/docs/scheduler/partitions.md b/docs/scheduler/partitions.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/scheduler/status.md b/docs/scheduler/status.md deleted file mode 100644 index e69de29..0000000 diff --git a/docs/software/developing.md b/docs/software/developing.md index c075264..63a36c1 100644 --- a/docs/software/developing.md +++ b/docs/software/developing.md @@ -1,6 +1,5 @@ --- -title: Developing Software on Franklin +title: Software Development summary: Accessing developer tools and setting up development environments. --- -# Developing Software on Franklin \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index f3dd4e7..17389b4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -4,39 +4,39 @@ repo_url: https://github.com/ucdavis/hpccf-docs copyright: Copyright © 2023-24 The Regents of the University of California, Davis nav: - - About: index.md - General: - Account Requests: general/account-requests.md - Accessing Clusters: general/access.md - - Job Scheduler: - - scheduler/index.md - - Slurm Commands: scheduler/commands.md + - Job Scheduling: + - Slurm: scheduler/index.md + - Commands: scheduler/commands.md - Resources: scheduler/resources.md - Job Scripts: scheduler/jobscripts.md - Software: - - software/index.md + - About: software/index.md - Module System: software/modules.md - Python and Conda: software/conda.md - R and RStudio: software/rlang.md + - Development: software/developing.md #- Developing Software: software/developing.md - Data Transfer: data-transfer.md - Clusters: - Farm: - - farm/index.md + - About: farm/index.md - Software: - Modules: farm/software/modules.md - Job Scheduling: farm/scheduling.md - Resources: farm/resources.md - Storage: farm/storage.md - Franklin: - - franklin/index.md + - About: franklin/index.md - Software: - Modules: franklin/software/modules.md - cryo-EM: franklin/software/cryoem.md - alphafold: franklin/software/alphafold.md - Job Scheduling: franklin/scheduling.md - Resources: franklin/resources.md - - Storage: farm/storage.md + - Storage: franklin/storage.md - Admin: - Network Architecture: admin/network.md - Virtual Machines: admin/vms.md @@ -101,9 +101,10 @@ theme: #- navigation.tabs - navigation.sections - navigation.expand - - navigation.indexes + #- navigation.indexes + - navigation.instant - navigation.top - - navigation.footer + #- navigation.footer - navigation.tracking - search.highlight - search.share