From 5da748ee16b2032e74c36116066848dcce0da7bc Mon Sep 17 00:00:00 2001 From: Cristian Di Pietrantonio Date: Sat, 24 Jun 2023 11:59:55 +0800 Subject: [PATCH] Update user-guide.rst Make it clear that the container image is bundled with the recipe when adding a local container. --- docs/getting_started/user-guide.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/getting_started/user-guide.rst b/docs/getting_started/user-guide.rst index 49cf8cd3c..95de9a36d 100644 --- a/docs/getting_started/user-guide.rst +++ b/docs/getting_started/user-guide.rst @@ -1876,7 +1876,8 @@ and tell shpc that we want it under the ``dinosaur/salad`` namespace. Registry entry dinosaur/salad:latest was added! Before shpc install, edit: /home/vanessa/Desktop/Code/shpc/registry/dinosaur/salad/container.yaml -At this point, you should open up the container.yaml generated and edit to your liking. +The container image will be copied within the newly-created directory structure, alongside the `container.yaml` file. +At this point, you should open up the generated `container.yaml` file and edit to your liking. This usually means updating the description, maintainer, aliases, and possibly providing a url to find more information or support. Also notice we've provided the tag to be latest. If you update this registry entry in the future with a new version, you'll want to provide a new tag. If you provide