You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2021/08/25 06:21:33 UTC
[GitHub] [flink] infoverload commented on a change in pull request #16970: [hotfix] How to build documentation using Hugo Docker image.
infoverload commented on a change in pull request #16970:
URL: https://github.com/apache/flink/pull/16970#discussion_r695420424
##########
File path: docs/README.md
##########
@@ -8,11 +8,20 @@ https://flink.apache.org/ is also generated from the files found here.
### Build the site 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.
+Building the site requires Hugo. You can install Hugo locally or use a Docker image to build the site.
+To build the Flink docs, you need the *extended version* of Hugo with Sass/SCSS support.
From the directory of this module (`docs`):
Review comment:
```suggestion
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.
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/.
```
##########
File path: docs/README.md
##########
@@ -8,11 +8,20 @@ https://flink.apache.org/ is also generated from the files found here.
### Build the site locally
Review comment:
```suggestion
### Build the documentation and serve it locally
```
##########
File path: docs/README.md
##########
@@ -8,11 +8,20 @@ https://flink.apache.org/ is also generated from the files found here.
### Build the site 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.
+Building the site requires Hugo. You can install Hugo locally or use a Docker image to build the site.
+To build the Flink docs, you need the *extended version* of Hugo with Sass/SCSS support.
From the directory of this module (`docs`):
+Using Hugo Docker image:
+```
+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
```
Review comment:
```suggestion
**Use a local Hugo installation**
After installing [Hugo](https://gohugo.io/getting-started/installing/) on your system, run the following script provided in this module:
```sh
./build_docs.sh
```
**Use a Docker image**
To start a live server at http://localhost:1313/ with a containerized image of Hugo Extended, run:
```
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
```
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: issues-unsubscribe@flink.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org