clean up docker workflow instructions and scripts (#4739)

* clean up docker workflow for website

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* add links to docker and colima

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* add images

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* fix formatting

Signed-off-by: Carlos Santana <csantana23@gmail.com>

* adding flexibility to run docker scripts from any directory

Signed-off-by: Carlos Santana <csantana23@gmail.com>
This commit is contained in:
Carlos Santana 2022-02-16 07:50:40 -05:00 committed by GitHub
parent bd90392136
commit 20741cdbcc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
30 changed files with 11043 additions and 38 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.4 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 28 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.8 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 403 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 402 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.8 KiB

View File

@ -10,9 +10,13 @@ If you choose to run the site locally, we strongly recommend using a container.
Regardless of the method used, when you submit a PR, a live preview link will be available in a comment on the PR. Regardless of the method used, when you submit a PR, a live preview link will be available in a comment on the PR.
## Use the Docker container ## (Option 1): Use the Docker container
To start the live preview, run the following script. You can use [Docker Desktop](https://www.docker.com/products/docker-desktop) or any docker engine supported for your operating system that is compatible with the `docker` CLI, for example [colima](https://github.com/abiosoft/colima).
### Live preview
To start the live preview, from any directory run the following script.
``` ```
./hack/docker/run.sh ./hack/docker/run.sh
``` ```
@ -20,11 +24,12 @@ Then open a web browser on http://localhost:8000
You can edit any file under `./docs` and the live preview autoreloads. You can edit any file under `./docs` and the live preview autoreloads.
When you're done with your changes, you can stop the container in another terminal. When you're done with your changes, you can stop the container using `Ctrl+C`.
```
./hack/docker/stop.sh
``` ### Full site build (optional)
You can run a complete build of the website with all versions using.
You can run a complete build of the website with all versions, from any directory run the following script.
``` ```
./hack/docker/test.sh ./hack/docker/test.sh
``` ```
@ -33,6 +38,11 @@ The build output is the entire static site located in `./site`.
You can preview the website locally by running a webserver using this directory like `npx http-server site -p 8000` if you have Node.js or `python3 -m http.server 8000` if you have Python 3 You can preview the website locally by running a webserver using this directory like `npx http-server site -p 8000` if you have Node.js or `python3 -m http.server 8000` if you have Python 3
## (Option 2) Using native Python mkdocs CLI
The website is built using [material-mkdocs](https://squidfunk.github.io/mkdocs-material/) which is a python tool based
on the `[mkdocs](https://www.mkdocs.org/) project.
### Install Material for MkDocs locally ### Install Material for MkDocs locally
Material for MkDocs is Python based and uses pip to install most of its required Material for MkDocs is Python based and uses pip to install most of its required
@ -43,21 +53,14 @@ from the [Python website](https://www.python.org).
For some (e.g. folks using RHEL), you might have to use pip3. For some (e.g. folks using RHEL), you might have to use pip3.
#### Install using pip Install Material for MkDocs and dependencies by running:
1. Install Material for MkDocs by running: ```
pip install -r requirements.txt
```
``` For more detailed instructions, see [Material for MkDocs documentation](https://squidfunk.github.io/mkdocs-material/getting-started/#installation)
pip install mkdocs-material
```
For more detailed instructions, see [Material for MkDocs documentation](https://squidfunk.github.io/mkdocs-material/getting-started/#installation)
1. Install the extensions to MkDocs needed for Knative by running:
```
pip install mkdocs-material-extensions mkdocs-macros-plugin mkdocs-exclude mkdocs-awesome-pages-plugin mkdocs-redirects
```
If you have `pip3` you can use the above commands and replace `pip` with `pip3` If you have `pip3` you can use the above commands and replace `pip` with `pip3`

View File

@ -1,13 +1,11 @@
#!/usr/bin/env sh #!/usr/bin/env sh
set -x SCRIPT_DIR=$(cd $(dirname "$0"); pwd -P)
NAME=${1:-knative-docs-dev}
PORT=${2:-8000} PORT=${2:-8000}
IMAGE=${3:-ghcr.io/knative/knative-docs:latest} IMAGE=${3:-ghcr.io/knative/knative-docs:latest}
docker rm "${NAME}" --force 1> /dev/null 2> /dev/null set -x
docker run --rm -p "${PORT}:8000" -v "${SCRIPT_DIR}/../../:/site" ${IMAGE} serve --dirtyreload --dev-addr=0.0.0.0:8000
docker run --name "${NAME}" -d -p "${PORT}:8000" -v "${PWD}:/site" ${IMAGE} serve --dirtyreload --dev-addr=0.0.0.0:8000
echo "Dev environment running with live reloading enabled. Open http://localhost:${PORT} to see the site"
docker logs -f ${NAME}

View File

@ -1,8 +0,0 @@
#!/usr/bin/env sh
NAME=${1:-knative-docs-dev}
echo "Cleaning up old container '${NAME}'..."
docker rm "${NAME}" --force 1> /dev/null 2> /dev/null
echo "Finished clean up"

View File

@ -1,9 +1,9 @@
#!/usr/bin/env sh #!/usr/bin/env sh
SCRIPT_DIR=$(cd $(dirname "$0"); pwd -P)
IMAGE=${1:-ghcr.io/knative/knative-docs:latest}
set -x set -x
NAME=${1:-knative-docs-dev}
PORT=${2:-8000}
IMAGE=${3:-ghcr.io/knative/knative-docs:latest}
docker run --rm -v "${PWD}:/site" -it --entrypoint "" ${IMAGE} hack/build.sh docker run --rm -v "${SCRIPT_DIR}/../../:/site" -it --entrypoint "" ${IMAGE} hack/build.sh