Skip to content

Commit be44972

Browse files
authored
Doc update (#636)
* Doc ppdate * Added another mention of the limitations of crane.ggcr.dev
1 parent 0a06353 commit be44972

File tree

2 files changed

+16
-4
lines changed

2 files changed

+16
-4
lines changed

docs/getting_started/developer-guide.rst

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1064,6 +1064,8 @@ will exist the second time when you add recipes.
10641064
Manually Adding Registry Entries
10651065
--------------------------------
10661066

1067+
.. _getting_started-developer-manual-registry-entries:
1068+
10671069
Great! Now you have an empty registry on your filesystem that will be pushed to GitHub
10681070
to serve as a remote. Make sure you are back on the main branch:
10691071

@@ -1085,7 +1087,14 @@ without any customization for executable discovery:
10851087
Registry entry vanessa/salad was added! Before shpc install, edit:
10861088
/tmp/my-registry/vanessa/salad/container.yaml
10871089
1088-
You could then edit that file to your liking. If you want to pull the container
1090+
You could then edit that file to your liking.
1091+
1092+
Like for ``shpc update`` :ref:`getting_started-commands-update`, tags are automatically
1093+
populated using `crane.ggcr.dev <https://crane.ggcr.dev/ls/quay.io/biocontainers/samtools>`_,
1094+
which only returns the 50 latest tags and obviously can only access public images.
1095+
If you see a ``crane digest`` error instead of tags, you'll have to populate the tags yourself.
1096+
1097+
Executables are by default missing. If you want shpc
10891098
to discover executables, you'll need to install guts:
10901099

10911100
.. code-block:: console

docs/getting_started/user-guide.rst

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -422,9 +422,12 @@ For example:
422422
$ cd /opt/lmod/my-registry
423423
424424
425-
And then you might want to inspect :ref:`getting_started-commands-add:` to see
426-
how to use shpc add to generate new container.yaml files. We are working on automation
427-
that can make this easier, so stay tuned for updates! After that, you'll still want to
425+
And then you might want to inspect :ref:`getting_started-commands-add` to see
426+
how to use ``shpc add`` to generate new container.yaml files.
427+
See :ref:`getting_started-creating-filesystem-registry` for instructions on how to
428+
create a registry and :ref:`getting_started-developer-manual-registry-entries` to
429+
populate the registry with new entries.
430+
After that, you'll still want to
428431
ensure your filesystem registry is known to shpc:
429432

430433
.. code-block:: console

0 commit comments

Comments
 (0)