Skip to content

Commit 4c78c5c

Browse files
committed
update README
1 parent 5605152 commit 4c78c5c

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,10 @@ source .venv/bin/activate # or venv\Scripts\activate on Windows
1010
uv sync --no-install-project
1111
mkdocs build
1212
```
13-
or
14-
```bash
13+
14+
or
15+
16+
```bash
1517
mkdocs serve
1618
```
1719

@@ -25,14 +27,18 @@ To develop the documentation with skaffold within a kubernetes cluster, create a
2527
SKAFFOLD_DEFAULT_REPO=docker.io/<your-docker-username>
2628
```
2729

28-
You need to sparse checkout the [vps-kubernetes-cluster repository](https://github.com/hololinked-dev/vps-kubernetes-cluster), which will be already available as a submodule in this repo in the `deployment\vps-kubernetes-cluster` directory. Instructions are available in the shell script `deployment/sparse-checkout.sh`. Sparse checkout is optional but the submodule must be available locally for the skaffold to work.
29-
30-
Once the ingress and apps helm chart is available locally, run:
30+
Please get in touch with me [by email](mailto:[email protected]) or on [discord](https://discord.com/invite/kEz87zqQXh) for cluster credentials.
3131

3232
```bash
3333
skaffold dev --module dev-python-docs
3434
```
3535

36+
Or use your own cluster if you have one set up. To test if the image is building
37+
38+
```bash
39+
skaffold build --module dev-python-docs
40+
```
41+
3642
### Docker
3743

3844
To build, tag, and publish the Docker image from your local machine, run:
@@ -43,4 +49,4 @@ docker build -t hololinked-docs .
4349
docker tag hololinked-docs:latest ghcr.io/hololinked-dev/hololinked-docs:latest
4450
docker push ghcr.io/hololinked-dev/hololinked-docs:latest
4551
echo "Docker image built and pushed successfully."
46-
```
52+
```

0 commit comments

Comments
 (0)