Update script documentation

ml6team · Nov 14, 2023 · cc604b3 · cc604b3
1 parent fa48d68
commit cc604b3
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 3 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -29,7 +29,8 @@ jobs:
       - name: Install fondant
         run: |
           pip install --upgrade pip
-          pip install fondant[docker]
+          pip install fondant[docker]@git+https://github.com/ml6team/fondant
+
 
       - name: Build components
         run: ./scripts/build_components.sh -r ghcr.io -n ml6team -t $GITHUB_SHA --label org.opencontainers.image.source="https://github.com/ml6team/fondant-usecase-RAG"
diff --git a/scripts/build_components.sh b/scripts/build_components.sh
@@ -8,8 +8,8 @@ function usage {
                                              The tag is set in the component specifications"
   echo "  -d,  --components-dir <value>      Directory containing components to build as subdirectories.
                                              The path should be relative to the root directory (default:src/components)"
-  echo "  -r,  --registry <value>            The docker registry prefix to use (default: null for DockerHub)"
-  echo "  -n,  --namespace <value>           The DockerHub namespace for the built images (default: ml6team)"
+  echo "  -r,  --registry <value>            The container registry prefix to use e.g. ghcr(default: null (DockerHub))"
+  echo "  -n,  --namespace <value>           The registry namespace for the built images (default: ml6team)"
   echo "  -co, --component <value>           Specific component to build. Pass the component subdirectory name(s) to build
                                              certain component(s) or 'all' to build all components in the components
                                              directory (default: all)"