From 3c3d99b98cd95cfad1c3dcf3a63977fcfef1403a Mon Sep 17 00:00:00 2001 From: Danielle Date: Mon, 4 Nov 2024 10:37:39 +0000 Subject: [PATCH] updated instructions for correct branch --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 721574b68..546e53cfe 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -64,7 +64,7 @@ pre-commit ## Self-Hosted -Our self-hosted docs are built using a tool called [Mike](https://github.com/jimporter/mike). Mike allows us to snapshot multiple versions of the documentation in a separate Git branch. In our case this branch is called `self-hosted-releases`. +Our self-hosted docs are built using a tool called [Mike](https://github.com/jimporter/mike). Mike allows us to snapshot multiple versions of the documentation in a separate Git branch. In our case this branch is called `self-hosted-releases-prod`. You can mostly ignore this while editing the docs, although there are a few things worth understanding. @@ -139,24 +139,26 @@ stack: When you open a PR against the repo, a Render preview will automatically be generated. This preview also includes the latest version of the self-hosted docs. This allows you to preview any changes you are making to the self-hosted docs. -If you would like to preview the self-hosted site locally, first fetch the `self-hosted-releases` branch, which Mike uses to serve its content: +If you would like to preview the self-hosted site locally, first fetch the `self-hosted-releases-prod` branch, which Mike uses to serve its content: ```shell -git fetch origin self-hosted-releases +git fetch origin self-hosted-releases-prod ``` Next, use `mike serve` to preview the site: ```shell -mike serve --branch self-hosted-releases +mike serve --branch self-hosted-releases-prod ``` Or via Docker: ```shell -docker run --pull always --rm -it -p 8000:8000 -v ${PWD}:/docs python:$(cat .python-version | tr -d '\n')-alpine sh -c "apk add git && git config --global --add safe.directory /docs && pip install mkdocs && pip install -r /docs/requirements.txt && cd /docs && mike serve --branch self-hosted-releases -a '0.0.0.0:8000'" +docker run --pull always --rm -it -p 8000:8000 -v ${PWD}:/docs python:$(cat .python-version | tr -d '\n')-alpine sh -c "apk add git && git config --global --add safe.directory /docs && pip install mkdocs && pip install -r /docs/requirements.txt && cd /docs && mike serve --branch self-hosted-releases-prod -a '0.0.0.0:8000'" ``` +Once it is ready, you will need to go to '0.0.0.0:8000/latest/' instead of just '0.0.0.0:8000'. + ## Submitting Changes Once you are happy with your changes, just open a pull request and ask for a review from `@spacelift-io/solutions-engineering`.