kubernetes
/
website
mirror of https://github.com/kubernetes/website.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #21772 from rlenferink/rename-docker 

Update docs for new container- Makefile targets
This commit is contained in:
Kubernetes Prow Robot 2020-06-16 20:32:39 -07:00 committed by GitHub
parent 13ca92d745 bdc173ce13
commit 859b1723c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 19 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
content/en/docs/contribute/new-content/open-a-pr.md
View File

@ -217,21 +217,37 @@ When you are ready to submit a pull request, commit your changes.
It's a good idea to preview your changes locally before pushing them or opening a pull request. A preview lets you catch build errors or markdown formatting problems. It's a good idea to preview your changes locally before pushing them or opening a pull request. A preview lets you catch build errors or markdown formatting problems.
You can either build the website's docker image or run Hugo locally. Building the docker image is slower but displays [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/), which can be useful for debugging. You can either build the website's container image or run Hugo locally. Building the container image is slower but displays [Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/), which can be useful for debugging.
{{< tabs name="tab_with_hugo" >}} {{< tabs name="tab_with_hugo" >}}
{{% tab name="Hugo in a container" %}} {{% tab name="Hugo in a container" %}}
{{< note >}}
The commands below use Docker as default container engine. Set the `CONTAINER_ENGINE` environment variable to override this behaviour.
{{< /note >}}
1. Build the image locally: 1. Build the image locally:
```bash ```bash
make docker-image # Use docker (default)
make container-image
### OR ###
# Use podman
CONTAINER_ENGINE=podman make container-image
``` ```
2. After building the `kubernetes-hugo` image locally, build and serve the site: 2. After building the `kubernetes-hugo` image locally, build and serve the site:
```bash ```bash
make docker-serve # Use docker (default)
make container-serve
### OR ###
# Use podman
CONTAINER_ENGINE=podman make container-serve
``` ```
3. In a web browser, navigate to `https://localhost:1313`. Hugo watches the 3. In a web browser, navigate to `https://localhost:1313`. Hugo watches the