diff --git a/README.md b/README.md index d74fbf4..a16b42a 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This repository leverages submodules. To clone the repository with submodules included: ```shell -git clone [URL] --recurse-submodules +git clone https://github.com/Better-HPC/keystone-docs --recurse-submodules ``` Submodules can also be pulled and updated manually: diff --git a/docs/assets/images/logo.svg b/docs/assets/images/logo.svg new file mode 100644 index 0000000..02ce3e3 --- /dev/null +++ b/docs/assets/images/logo.svg @@ -0,0 +1,16 @@ + diff --git a/docs/deploy/install/docker.md b/docs/deploy/install/docker.md index 754797e..a2f252e 100644 --- a/docs/deploy/install/docker.md +++ b/docs/deploy/install/docker.md @@ -32,7 +32,7 @@ docker run \ --publish 8000:80 \ --name keystone \ --env SECRET_KEY="this-is-a-secure-secret" - docker.cloudsmith.io/better-hpc/keystone/keystone-api:latest + artifacts.bhpc.dev/keystone/keystone-api:latest ``` The container will automatically launch minimal instances for all required @@ -70,7 +70,7 @@ docker run \ --publish 80:80 \ --name keystone-web \ --env API_URL="http://localhost:8000" \ - docker.cloudsmith.io/better-hpc/keystone/keystone-web:latest + artifacts.bhpc.dev/keystone//keystone-web:latest ``` Once both containers are running, the web interface will be available at diff --git a/docs/deploy/install/systemd.md b/docs/deploy/install/systemd.md index 2fd1960..8233d0b 100644 --- a/docs/deploy/install/systemd.md +++ b/docs/deploy/install/systemd.md @@ -8,7 +8,7 @@ Doing so requires administrative privileges and assumes you are familiar with ma The `keystone_api` package can be installed using the `pipx` package manager. ```bash -BHPC_REPO="https://dl.cloudsmith.io/public/better-hpc/keystone/python/simple/" +BHPC_REPO="https://artifacts.bhpc.dev/pypi/keystone-python/simple/" pipx install --extra-index-url=$BHPC_REPO --include-deps keystone-api ``` diff --git a/docs/integrate/sdk/getting-started.md b/docs/integrate/sdk/getting-started.md index 3b63999..a109195 100644 --- a/docs/integrate/sdk/getting-started.md +++ b/docs/integrate/sdk/getting-started.md @@ -11,21 +11,21 @@ using any standard Python package manager: === "pip" ```sh - BHPC_REPO="https://dl.cloudsmith.io/public/better-hpc/keystone/python/simple/" + BHPC_REPO="https://artifacts.bhpc.dev/pypi/keystone-python-client/simple/" pip install --extra-index-url=$BHPC_REPO keystone-api-client ``` === "uv" ```sh - BHPC_REPO="https://dl.cloudsmith.io/public/better-hpc/keystone/python/simple/" + BHPC_REPO="https://artifacts.bhpc.dev/pypi/keystone-python-client/simple/" uv add --index=$BHPC_REPO keystone-api-client ``` === "poetry" ```sh - BHPC_REPO="https://dl.cloudsmith.io/public/better-hpc/keystone/python/simple/" + BHPC_REPO="https://artifacts.bhpc.dev/pypi/keystone-python-client/simple/" poetry source add --priority=supplemental bhpc $BHPC_REPO poetry add keystone-api-client ```