Docs: add admin docs content #30

Merged
mslw merged 8 commits from docs-personnel into main 2023-05-31 15:44:02 +00:00

8 commits

Author SHA1 Message Date
797263c785 docs: add links to admin docs
Adds link to the latest singularity image from appveyor. Addds links
to our GitHub repo and SingularityCE (sylabs) documentation.
2023-05-31 16:55:11 +02:00
ca2affc855 docs: restructure admin docs a little 2023-05-31 16:46:37 +02:00
0e643d9d53 docs: describe scripts in detail
This adds slightly reformatted docstrings, copied from respective
scripts, into the admin documentation. Getting ahead of the current
main branch, the docs content borrows updated name and docstring from
PR #33

Admittedly, this is a lot of copy-pasted text. Ideally, we could build
docstrings as part of the doc build process, but given that we plan to
keep the design stable I think it's OK to leave it at that.
2023-05-31 16:36:08 +02:00
ba7edefae8 docs: explain "installing" singularity image
This explains how to create a script that defines a bind point and
does the singularity run call, and add it under /usr/bin - based on
how it's done in the CI setup.

Suggested-by: Adina Wagner <adina.wagner@t-online.de>
2023-05-31 16:04:49 +02:00
29954a1594 docs: rename icf personnel guide to administratod docs 2023-05-31 16:04:49 +02:00
2a4477e723 docs: retitle icf personnel guide to administratod docs 2023-05-31 16:04:49 +02:00
c1ff8683d1 docs: add an overview of icf scripts
Scripts are described with one-sentence explanation, and a copy-paste
of the usage message from -h.
2023-05-31 16:04:49 +02:00
d597e4a366 docs: intro & subsection headers for personnel guide 2023-05-31 16:04:49 +02:00