This is an automated email from the ASF dual-hosted git repository.
sjwiesman pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink.git
The following commit(s) were added to refs/heads/master by this push:
new 8b307b0 [hotfix] How to build documentation using Hugo Docker image.
8b307b0 is described below
commit 8b307b0c42e39ea71e7da03a82c082a2dd146662
Author: Thomas Weise <[email protected]>
AuthorDate: Tue Aug 24 11:26:56 2021 -0700
[hotfix] How to build documentation using Hugo Docker image.
Co-authored-by: Daisy T <[email protected]>
This closes #16970
---
docs/README.md | 23 ++++++++++++++++++-----
1 file changed, 18 insertions(+), 5 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 0b806ca..593454b 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -6,15 +6,28 @@ https://flink.apache.org/ is also generated from the files
found here.
# Requirements
-### Build the site locally
+### Build the documentation and serve it locally
-Make sure you have installed
[Hugo](https://gohugo.io/getting-started/installing/) on your
-system. To build the Flink docs, you need the *extended version* of Hugo with
Sass/SCSS support.
+The Flink documentation uses
[Hugo](https://gohugo.io/getting-started/installing/) to generate HTML files.
More specifically, it uses the *extended version* of Hugo with Sass/SCSS
support.
-From the directory of this module (`docs`):
+To build the documentation, you can install Hugo locally or use a Docker
image.
+
+Both methods require you to execute commands in the directory of this module
(`docs/`). The built site is served at http://localhost:1313/.
+
+#### Using Hugo Docker image:
+
+```sh
+$ git submodule update --init --recursive
+$ docker run -v $(pwd):/src -p 1313:1313 jakejarvis/hugo-extended:latest
server --buildDrafts --buildFuture --bind 0.0.0.0
+```
+
+#### Local Hugo installation:
+
+Make sure you have installed
[Hugo](https://gohugo.io/getting-started/installing/) on your system.
```sh
-./build_docs.sh
+$ git submodule update --init --recursive
+$ ./build_docs.sh
```
The site can be viewed at http://localhost:1313/
