Skip to content

Latest commit

 

History

History
21 lines (14 loc) · 939 Bytes

File metadata and controls

21 lines (14 loc) · 939 Bytes

singularity docs 1

Make sure the singularity tools are self documenting.

These are the tools:

  • test.sh
  • orbit/warpdrive.sh
  • denis/configure.sh
  • mailman/inspector.sh
  • backup/{backup,restore}.sh

Ensure the help output, i.e. the output from passing the -h flag to any of the scripts, is consistent.

As of the time of writing, the test.sh script has no documentation. We plan to overhaul our testing in the near future so don't spent too much time on test.sh

Once you are familiar with all of the scripts, create documentation describing the purpose and function of each tool.

We already did some of this here which can be partially used as a starting point, however this document was created for a different purpose and gets into unnecessary detail about performing specific tasks with specific command as part of a proposed workflow.