From cc03cdab2149e4c52512b2574ec1b687faf8c25f Mon Sep 17 00:00:00 2001 From: amit dixit Date: Fri, 23 Jul 2021 13:35:15 +0200 Subject: [PATCH] fix for issues #12039 and #12025 --- site/README.md | 50 +++++++++++++++----------------------------------- 1 file changed, 15 insertions(+), 35 deletions(-) diff --git a/site/README.md b/site/README.md index 4dca11d1b8..926a8d6277 100644 --- a/site/README.md +++ b/site/README.md @@ -1,28 +1,23 @@ -[Minikube](https://minikube.sigs.k8s.io/docs/) uses Docsy theme. -[Docsy](https://github.com/google/docsy) is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This **Docsy Example Project** uses the Docsy theme, as well as providing a skeleton documentation structure for you to use. You can either copy this project and edit it with your own content, or use the theme in your projects like any other [Hugo theme](https://themes.gohugo.io/). - -This Docsy Example Project is hosted at [https://goldydocs.netlify.com/](https://goldydocs.netlify.com/). +[Docsy](https://github.com/google/docsy) is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This **Minikube project** uses the Docsy theme for [Minikube Website](https://minikube.sigs.k8s.io/docs/). You can find detailed theme instructions in the Docsy user guide: https://docsydocs.netlify.com/docs/ -This is not an officially supported Google product. This project is currently maintained. -## Cloning the Docsy Example Project - -The following will give you a project that is set up and ready to use (don't forget to use `--recurse-submodules` or you won't pull down some of the code you need to generate a working site). The `hugo server` command builds and serves the site. If you just want to build the site, run `hugo` instead. +## Running the website locally +Clone the minikube project fork with option ```--recurse-submodules --depth 1 ``` to download and update submodule dependencies. ```bash -git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git -cd docsy-example -hugo server +git clone --recurse-submodules --depth 1 https://github.com/kubernetes/minikube.git # replace path with your github fork of minikube +cd minikube/site +hugo server # to server site locally ``` The theme is included as a Git submodule: ```bash ▶ git submodule - a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master) + 2536303cad19991c673037f4f16332075141364a themes/docsy (2536303) ``` If you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`): @@ -30,29 +25,14 @@ If you want to do SCSS edits and want to publish these, you need to install `Pos ```bash npm install ``` - - - -## Running the website locally - -Once you've cloned the site repo, from the repo root folder, run: - -``` -hugo server -```