Skip to content

Commit

Permalink
Update sharing.rst
Browse files Browse the repository at this point in the history
Adding link to documentation lesson and fixing typo (left versus right tab)
  • Loading branch information
maikenp authored Oct 10, 2024
1 parent 74a493c commit f4b1c85
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion content/sharing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,7 @@ The main purpose of a software image is exactly that - to provide software, not

Instead of shipping the data with the image, let the user bind mount it into the container. Check out the :doc:`Binding folders into your container lesson <binding_folders>` for details.

Compare the two apptainer definition files and how to run the resulting ``my_container.sif`` container. The left tab also exemplifies bind-mounting a folder for output data, which is useful in order to access the resulting output data directly from the host server.
Compare the two apptainer definition files and how to run the resulting ``my_container.sif`` container. The right tab also exemplifies bind-mounting a folder for output data, which is useful in order to access the resulting output data directly from the host server.

.. tabs::

Expand Down Expand Up @@ -250,6 +250,17 @@ Compare the two apptainer definition files and how to run the resulting ``my_con
%help
Usage: apptainer run --bind /path/to/host/input:/app/input_data,/path/to/host/output:/app/output_data this_container.sif
Documentating your image
-----------------------------------
In the example above you can see that some documentation is added in the image itself under the ```%help``` block. This is not only important for sharing, but also for yourself to help remember how to use the container. See more details in the :ref:`Adding documentation to your image <documentation>`.


.. admonition:: Document your image

Always add documentation to your image.
- Minimally how to use the container via the ```%help``` block
- In addition author, version, description via the ```%label``` block


Use version control and public registries
-----------------------------------------
Expand Down

0 comments on commit f4b1c85

Please sign in to comment.