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

fix for issues #12039 and #12025

pull/12040/head
amit dixit 2021-07-23 13:35:15 +02:00
parent 7dab2e078e
commit cc03cdab21
1 changed files with 15 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

50
site/README.md
View File

@ -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/). [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/).
This Docsy Example Project is hosted at [https://goldydocs.netlify.com/](https://goldydocs.netlify.com/).
You can find detailed theme instructions in the Docsy user guide: https://docsydocs.netlify.com/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 ## Running the website locally
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.
Clone the minikube project fork with option ```--recurse-submodules --depth 1 ``` to download and update submodule dependencies.
```bash ```bash
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git git clone --recurse-submodules --depth 1 https://github.com/kubernetes/minikube.git # replace path with your github fork of minikube
cd docsy-example cd minikube/site
hugo server hugo server # to server site locally
``` ```
The theme is included as a Git submodule: The theme is included as a Git submodule:
```bash ```bash
▶ git submodule ▶ 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`): 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 ```bash
npm install npm install
``` ```
### Common Issues
<!--### Cloning the Example from the Theme Project
```bash ```bash
git clone --recurse-submodules --depth 1 https://github.com/docsy.git Start building sites …
cd tech-doc-hugo-theme/exampleSite hugo v0.86.0+extended darwin/amd64 BuildDate=unknown
HUGO_THEMESDIR="../.." hugo server Error: Error building site: "/minikube/site/content/en/docs/contrib/releasing/binaries.md:64:1": failed to extract shortcode: template for shortcode "alert" not found
Built in 667 ms
``` ```
> This indicates the submodules are not upated.
Please run the following command to fix.
``` git submodule update --init --recursive ```
Note that the Hugo Theme Site requires the `exampleSite` to live in a subfolder of the theme itself. To avoid recursive duplication, the example site is added as a Git subtree:
```bash
git subtree add --prefix exampleSite https://github.com/google/docsy.git master --squash
```
To pull in changes, see `pull-deps.sh` script in the theme.-->
## Running the website locally
Once you've cloned the site repo, from the repo root folder, run:
```
hugo server
```