Docs: add admin docs content #30

Merged

mslw merged 8 commits from docs-personnel into main

2023-05-31 15:44:02 +00:00

mslw commented

2023-05-31 11:47:28 +00:00

(Migrated from github.com)

This provides an overview of the archive generation content - singularity setup and scripts to run.

Admittedly, this contains a lot of text that was copy-pasted from our script docstrings. 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 for now.

This provides an overview of the archive generation content - singularity setup and scripts to run. Admittedly, this contains a lot of text that was copy-pasted from our script docstrings. 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 for now.

🚀 2

adswa (Migrated from github.com) reviewed

2023-05-31 13:07:03 +00:00

docs/source/personnel.rst

Maybe we can also add how the appveyor setup does it (installing it as icf-utils):

echo -e '#!/bin/sh\nset -e -u\nsingularity run -B /data /home/appveyor/projects/inm-icf-utilities/icf.sif "$@"' > icf-utils
sudo install -t /usr/bin icf-utils

Maybe we can also add how the appveyor setup does it (installing it as ``icf-utils``): ``` echo -e '#!/bin/sh\nset -e -u\nsingularity run -B /data /home/appveyor/projects/inm-icf-utilities/icf.sif "$@"' > icf-utils sudo install -t /usr/bin icf-utils ```

adswa (Migrated from github.com) reviewed

2023-05-31 13:16:58 +00:00

docs/source/personnel.rst

What about changing the name of this section to "Administrator docs"? Matches the sound and feel of Developer docs, and makes it semantically meaningful also for people who don't know the ICF

mslw (Migrated from github.com) reviewed

2023-05-31 13:29:25 +00:00

docs/source/personnel.rst

Right, there's also binding (-B /data) to be taken care of.

Right, there's also binding (`-B /data`) to be taken care of.

adswa (Migrated from github.com) reviewed

2023-05-31 13:30:10 +00:00

docs/source/personnel.rst

so maybe something like

The singularity image can also be installed as if it is a system package.
For this, fill in the placeholders in the following call:

.. code-block::

   echo -e '#!/bin/sh\nset -e -u\nsingularity run -B <absolute-path-to-data> <absolute-path-to-icf.sif-file> "$@"' > icf-utils

Afterwards, install it under ``/usr/bin`` to make all functionality available under an ``icf-utils`` command.

.. code-block::

   sudo install -t /usr/bin icf-utils 

.. code-block::

   icf-utils make_studyvisit_archive -h                                                                                 2 !
   usage: make_studyvisit_archive [-h] [-o PATH] --id STUDY-ID VISIT-ID <input-dir>

so maybe something like ```ReST The singularity image can also be installed as if it is a system package. For this, fill in the placeholders in the following call: .. code-block:: echo -e '#!/bin/sh\nset -e -u\nsingularity run -B <absolute-path-to-data> <absolute-path-to-icf.sif-file> "$@"' > icf-utils Afterwards, install it under ``/usr/bin`` to make all functionality available under an ``icf-utils`` command. .. code-block:: sudo install -t /usr/bin icf-utils .. code-block:: icf-utils make_studyvisit_archive -h 2 ! usage: make_studyvisit_archive [-h] [-o PATH] --id STUDY-ID VISIT-ID <input-dir> ```