Skip to content

Commit a4c207a

Browse files
authored
Merge pull request #620 from muffato/patch-1
Update developer-guide.rst
2 parents d9116c0 + 68527b3 commit a4c207a

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

docs/getting_started/developer-guide.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -858,7 +858,7 @@ GitHub Action
858858

859859
As of version ``0.1.17`` we provide a GitHub action that will allow you to update
860860
a registry from an container binary cache. Does any of this not make sense?
861-
Don't worry! We we have a full tutorial soon to walk you through this process.
861+
Don't worry! We have a full tutorial below to walk you through this process.
862862
For now, here is how to use the action provided here alongside your remote
863863
registry (e.g., running in GitHub actions) to update from a container executable
864864
cache of interest. For the example here, we are updating the ``singularityhub/shpc-registry``
@@ -927,8 +927,8 @@ show you how to:
927927
2. Create a new container executable cache
928928
3. Automate updates of the cache to your registry
929929

930-
Prepare a Remote Registry
931-
-------------------------
930+
Preparing a Remote Registry
931+
---------------------------
932932

933933
To start, `create a new repository <https://docs.github.com/en/get-started/quickstart/create-a-repo>`_
934934
and follow the instructions in :ref:`getting_started-creating-remote-registry` to
@@ -993,6 +993,8 @@ You should only do this after you've fetched, as you will no longer be connected
993993
remote! Now that you've changed the remote and commit, push your changes and then push to your main branch. We do this
994994
push before gh-pages so "main" becomes the primary branch.
995995

996+
.. code-block:: console
997+
996998
$ git push origin main
997999
9981000
Then you can checkout the gh-pages branch to do the same cleanup and push.
@@ -1015,8 +1017,8 @@ And then commit and push to gh-pages.
10151017
$ git push origin gh-pages
10161018
10171019
1018-
Manually Add Registry Entries
1019-
-----------------------------
1020+
Manually Adding Registry Entries
1021+
--------------------------------
10201022

10211023
Great! Now you have an empty registry on your filesystem that will serve as a remote.
10221024
Make sure you are back on the main branch:

0 commit comments

Comments
 (0)