From b22dae1712eb36afde1874f2fde3d844091a428d Mon Sep 17 00:00:00 2001 From: Douglas Schilling Landgraf Date: Tue, 22 Sep 2020 14:49:52 -0400 Subject: [PATCH 1/2] README.md: Specify Hugo version Not all Linux distros or Operating Systems ship Hugo Extended version as default. If users try to run the website project without the extended version it will fail. Signed-off-by: Douglas Schilling Landgraf --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dce4cb91a6..592fb560e7 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ This repository contains the assets required to build the [Kubernetes website an # Using this repository -You can run the website locally using Hugo, or you can run it in a container runtime. We strongly recommend using the container runtime, as it gives deployment consistency with the live website. +You can run the website locally using Hugo (Extended version), or you can run it in a container runtime. We strongly recommend using the container runtime, as it gives deployment consistency with the live website. ## Prerequisites @@ -15,7 +15,7 @@ To use this repository, you need the following installed locally: - [yarn](https://yarnpkg.com/) - [npm](https://www.npmjs.com/) - [Go](https://golang.org/) -- [Hugo](https://gohugo.io/) +- [Hugo (Extended version)](https://gohugo.io/) - A container runtime, like [Docker](https://www.docker.com/). Before you start, install the dependencies. Clone the repository and navigate to the directory: From 407eb62fcf8b624fd984e944bb46fcfcd8b4b808 Mon Sep 17 00:00:00 2001 From: Douglas Schilling Landgraf Date: Tue, 22 Sep 2020 15:10:59 -0400 Subject: [PATCH 2/2] README.md: add troubleshooting session for hugo In case users run hugo (non extension version) we should have a quick link for helping new developers/users to solve the website build issue. Signed-off-by: Douglas Schilling Landgraf --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 592fb560e7..2ec74cceaf 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,11 @@ make serve This will start the local Hugo server on port 1313. Open up your browser to http://localhost:1313 to view the website. As you make changes to the source files, Hugo updates the website and forces a browser refresh. +## Troubleshooting +### error: failed to transform resource: TOCSS: failed to transform "scss/main.scss" (text/x-scss): this feature is not available in your current Hugo version + +Hugo is shipped in two set of binaries for technical reasons. The current website runs based on the **Hugo Extended** version only. In the [release page](https://github.com/gohugoio/hugo/releases) look for archives with `extended` in the name. To confirm, run `hugo version` and look for the word `extended`. + ### Troubleshooting macOS for too many open files If you run `make serve` on macOS and receive the following error: