forked from EPCCed/eidf-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathmkdocs.yml
More file actions
167 lines (160 loc) · 8.33 KB
/
mkdocs.yml
File metadata and controls
167 lines (160 loc) · 8.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
theme:
name: material
custom_dir: overrides
favicon: images/favicon.ico
logo: images/EIDF_rgb.png
palette:
scheme: default
features:
- tabs
icon:
repo: fontawesome/brands/github
extra_css:
- stylesheets/eidf.css
- stylesheets/access.css
site_name: EIDF User Documentation
site_url: https://docs.eidf.ac.uk/
repo_url: https://github.com/EPCCed/eidf-docs/
repo_name: EPCCed/eidf-docs.git
edit_uri: edit/main/docs/
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:mermaid2.fence_mermaid_custom
- attr_list
plugins:
- search
- mermaid2:
version: 11.10.1
nav:
- "Service Status": status/index.md
- "Documentation overview": index.md
- "About EIDF":
- "Introduction": overview/index.md
- "Acknowledgements": overview/acknowledgements.md
- "Contact": overview/contacts.md
- "Service Access":
- "Web and SSH": access/index.md
- "EIDF Web Portal": access/project.md
- "Virtual Desktop Interface": access/virtualmachines-vdi.md
- "Storage in the EIDF":
- "Overview": storage/overview.md
- "FAQs": storage/faq.md
- "Computing Services":
- "Virtual Desktops":
- "Overview": services/virtualmachines/index.md
- "QuickStart": services/virtualmachines/quickstart.md
- "Managing VMs": services/virtualmachines/docs.md
- "Virtual Desktop Interface": access/virtualmachines-vdi.md
- "Shared Filesystem": services/virtualmachines/sharedfs.md
- "SSH Access to VMs": access/ssh.md
- "VM Flavours": services/virtualmachines/flavours.md
- "Policies": services/virtualmachines/policies.md
- "RDP tunnelling over SSH": services/virtualmachines/rdp-tunnelling.md
- "Ultra2":
- "Overview": services/ultra2/access.md
- "Connect": services/ultra2/connect.md
- "Running codes": services/ultra2/run.md
- "Cerebras":
- "Overview": services/cerebras/access.md
- "Connect": services/cerebras/connect.md
- "Running codes": services/cerebras/run.md
- "GPU Service":
- "Overview": services/gpuservice/index.md
- "Policies": services/gpuservice/policies.md
- "Kueue": services/gpuservice/kueue.md
- "Shared Filesystem (CephFS) PVCs": services/gpuservice/shared-cephfs.md
- "Tutorials":
- "Getting Started": services/gpuservice/training/L1_getting_started.md
- "Persistent Volumes": services/gpuservice/training/L2_requesting_persistent_volumes.md
- "Running a Pytorch Pod": services/gpuservice/training/L3_running_a_pytorch_task.md
- "Template K8s Workflow": services/gpuservice/training/L4_template_workflow.md
- "GPU Service FAQ": services/gpuservice/faq.md
- "Graphcore Bow Pod64":
- "Overview": services/graphcore/index.md
- "Tutorial":
- "Getting Started": services/graphcore/training/L1_getting_started.md
- "Multi-IPU Jobs": services/graphcore/training/L2_multiple_IPU.md
- "Profiling": services/graphcore/training/L3_profiling.md
- "Other Frameworks": services/graphcore/training/L4_other_frameworks.md
- "Graphcore FAQ": services/graphcore/faq.md
- "Notebooks":
- "Overview": services/jhub/index.md
- "Quickstart": services/jhub/quickstart.md
- "Data Services":
- "S3":
- "Overview": services/s3/index.md
- "Manage": services/s3/manage.md
- "Tutorial": services/s3/tutorial.md
- "Data Publishing":
- "Getting started": services/datapublishing/service.md
- "Your Data Catalogue entry": services/datapublishing/catalogue.md
- "Data Catalogue":
- "Metadata information": services/datacatalogue/metadata.md
#- "Managed File Transfer":
# - "Quickstart": services/mft/quickstart.md
# - "Using the MFT": services/mft/using-the-mft.md
- "Code Collaboration":
- "Gitlab Overview": services/gitlab/index.md
- "Gitlab Quickstart": services/gitlab/quickstart.md
- "Safe Haven Services":
- "Overview": safe-haven-services/overview.md
- "Access": safe-haven-services/safe-haven-access.md
- "Software Management": safe-haven-services/software-management.md
- "HPC Service":
- "Accessing HPC in Safe Havens": safe-haven-services/shs-superdome-flex/L1_Accessing_the_SDF_Inside_the_EPCC_SHS.md
- "Running R/Python Scripts": safe-haven-services/shs-superdome-flex/L2_running_R_Python_analysis_scripts.md
- "Submitting Scripts to Slurm": safe-haven-services/shs-superdome-flex/L3_submitting_scripts_to_slurm.md
- "Parallelised Python Analysis": safe-haven-services/shs-superdome-flex/L4_parallelised_python_analysis.md
- "Parallelised R Analysis": safe-haven-services/shs-superdome-flex/L5_parallelised_r_analysis.md
- "Container Service":
- "Accessing and running containers in Safe Havens": safe-haven-services/shs-container-user-guide/introduction.md
- "Development Workflow": safe-haven-services/shs-container-user-guide/development-workflow.md
- "Workflow Examples": safe-haven-services/shs-container-user-guide/workflow-examples.md
- "Container Examples": safe-haven-services/shs-container-user-guide/container-examples.md
# TRE GPU service docs can be uncommented and added to
# the navigation menu when the TRE GPU service is made
# available to TRE tenants. See Umair Ayub and Kostas for details.
# - "TRE GPU Service":
# - "Overview": safe-haven-services/tre-gpu-service/index.md
# - "Policies": safe-haven-services/tre-gpu-service/policies.md
# - "Kueue": safe-haven-services/tre-gpu-service/kueue.md
# - "Tutorials":
# - "Getting Started": safe-haven-services/tre-gpu-service/training/L1_getting_started.md
# - "Building and Pushing Containers to GHCR": safe-haven-services/tre-gpu-service/training/L1.1_building-and-testing-containers.md
# - "Downloading Containers in the TRE GPU Cluster": safe-haven-services/tre-gpu-service/training/L2_using-containers-in-the-tre.md
# - "Creating your first pod template within a job yaml file": safe-haven-services/tre-gpu-service/training/L2.1_creating-your-first-pod-template.md
# - "Transfer Data Inside the TRE GPU Cluster": safe-haven-services/tre-gpu-service/training/L3_Accessing_the_BeeGFS_Inside_the_EPCC_TRE.md
# - "Persistent Volumes": safe-haven-services/tre-gpu-service/training/L4_requesting_persistent_volumes.md
# - "GPU Service FAQ": safe-haven-services/tre-gpu-service/faq.md
# Application Services (Open OnDemand) docs can be uncommented
# and added to the navigation menu when the service is made
# available to safe haven users. See MikeJ for details.
#- "Application Services":
# - "About Safe Haven Services Application Services": safe-haven-services/open-ondemand/about.md
# - "Access": safe-haven-services/open-ondemand/access.md
# - "Getting started": safe-haven-services/open-ondemand/getting-started.md
# - "Home page": safe-haven-services/open-ondemand/home-page.md
# - "Run jobs": safe-haven-services/open-ondemand/jobs.md
# - "Run containers": safe-haven-services/open-ondemand/containers.md
# - "View and run apps": safe-haven-services/open-ondemand/apps.md
# - "Browse and manage files": safe-haven-services/open-ondemand/files.md
# - "Log into back-ends": safe-haven-services/open-ondemand/ssh.md
# - "Apps":
# - "Active Jobs": safe-haven-services/open-ondemand/apps/active-jobs.md
# - "Run Batch Container": safe-haven-services/open-ondemand/apps/batch-container-app.md
# - "Run JupyterLab": safe-haven-services/open-ondemand/apps/jupyter-os-app.md
# - "Run JupyterLab Container": safe-haven-services/open-ondemand/apps/jupyter-app.md
# - "Run RStudio Server Container": safe-haven-services/open-ondemand/apps/rstudio-app.md
# - "Job Composer": safe-haven-services/open-ondemand/apps/job-composer.md
# - "Tips": safe-haven-services/open-ondemand/tips.md
# WIP: TRE Code Management docs
# - "[Beta] Code Management and Mirroring Service": safe-haven-services/code-management-mirroring-service.md
- "EIDF Known Issues": known-issues/index.md
- "EIDF Frequently Asked Questions": faq/index.md
- "EIDF Tutorial Videos": tutorial-videos/index.md
dev_addr: localhost:8000