diff --git a/site/README.md b/site/README.md index 0ee275ebf2..4121b87e77 100644 --- a/site/README.md +++ b/site/README.md @@ -1,26 +1,23 @@ -[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`): @@ -28,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 -``` diff --git a/site/content/en/docs/benchmarks/cpuUsage/linux/_index.md b/site/content/en/docs/benchmarks/cpuUsage/linux.md similarity index 100% rename from site/content/en/docs/benchmarks/cpuUsage/linux/_index.md rename to site/content/en/docs/benchmarks/cpuUsage/linux.md diff --git a/site/content/en/docs/benchmarks/cpuUsage/macOS/_index.md b/site/content/en/docs/benchmarks/cpuUsage/macos.md similarity index 100% rename from site/content/en/docs/benchmarks/cpuUsage/macOS/_index.md rename to site/content/en/docs/benchmarks/cpuUsage/macos.md diff --git a/site/content/en/docs/benchmarks/imageBuild/benchmarkingProcess/_index.md b/site/content/en/docs/benchmarks/imageBuild/benchmarkingprocess.md similarity index 100% rename from site/content/en/docs/benchmarks/imageBuild/benchmarkingProcess/_index.md rename to site/content/en/docs/benchmarks/imageBuild/benchmarkingprocess.md diff --git a/site/content/en/docs/benchmarks/imageBuild/linux/_index.md b/site/content/en/docs/benchmarks/imageBuild/linuxbenchmark.md similarity index 100% rename from site/content/en/docs/benchmarks/imageBuild/linux/_index.md rename to site/content/en/docs/benchmarks/imageBuild/linuxbenchmark.md diff --git a/site/content/en/docs/benchmarks/imageBuild/mac/_index.md b/site/content/en/docs/benchmarks/imageBuild/macbenchmark.md similarity index 100% rename from site/content/en/docs/benchmarks/imageBuild/mac/_index.md rename to site/content/en/docs/benchmarks/imageBuild/macbenchmark.md diff --git a/site/content/en/docs/benchmarks/imageBuild/minikubeVsOthers/_index.md b/site/content/en/docs/benchmarks/imageBuild/minikubevsothers.md similarity index 100% rename from site/content/en/docs/benchmarks/imageBuild/minikubeVsOthers/_index.md rename to site/content/en/docs/benchmarks/imageBuild/minikubevsothers.md diff --git a/site/content/en/docs/tutorials/custom_cert_ingress.md b/site/content/en/docs/tutorials/custom_cert_ingress.md index dd6e0865f6..f130549903 100644 --- a/site/content/en/docs/tutorials/custom_cert_ingress.md +++ b/site/content/en/docs/tutorials/custom_cert_ingress.md @@ -1,6 +1,6 @@ --- title: "How to use custom TLS certificate with ingress addon" -linkTitle: "Using custom TLS certificate with ingress addon" +linkTitle: "Using Custom TLS certificate with Ingress Addon" weight: 1 date: 2020-11-30 --- diff --git a/site/content/en/docs/tutorials/kubevirt.md b/site/content/en/docs/tutorials/kubevirt.md index 6116bb1678..5fddb46ba5 100644 --- a/site/content/en/docs/tutorials/kubevirt.md +++ b/site/content/en/docs/tutorials/kubevirt.md @@ -1,6 +1,6 @@ --- title: "How to use KubeVirt with minikube" -linkTitle: "KubeVirt support" +linkTitle: "KubeVirt Support" weight: 1 date: 2020-05-26 description: > diff --git a/site/content/en/docs/tutorials/multi_node.md b/site/content/en/docs/tutorials/multi_node.md index aef19f9722..51eab5b216 100644 --- a/site/content/en/docs/tutorials/multi_node.md +++ b/site/content/en/docs/tutorials/multi_node.md @@ -1,6 +1,6 @@ --- title: "Using Multi-Node Clusters" -linkTitle: "Using multi-node clusters" +linkTitle: "Using Multi-Node Clusters" weight: 1 date: 2019-11-24 --- diff --git a/site/content/en/docs/tutorials/nginx_tcp_udp_ingress.md b/site/content/en/docs/tutorials/nginx_tcp_udp_ingress.md index f38712de76..7c9fd083ce 100644 --- a/site/content/en/docs/tutorials/nginx_tcp_udp_ingress.md +++ b/site/content/en/docs/tutorials/nginx_tcp_udp_ingress.md @@ -1,6 +1,6 @@ --- title: "Ingress nginx for TCP and UDP services" -linkTitle: "Ingress nginx for TCP and UDP services" +linkTitle: "Ingress Nginx for TCP and UDP Services" weight: 1 date: 2019-08-15 description: > diff --git a/site/content/en/docs/tutorials/nvidia_gpu.md b/site/content/en/docs/tutorials/nvidia_gpu.md index 80c454933d..ca5ee78620 100644 --- a/site/content/en/docs/tutorials/nvidia_gpu.md +++ b/site/content/en/docs/tutorials/nvidia_gpu.md @@ -1,6 +1,6 @@ --- title: "NVIDIA GPU Support" -linkTitle: "NVIDIA GPU support" +linkTitle: "NVIDIA GPU Support" weight: 1 date: 2018-01-02 description: > diff --git a/site/content/en/docs/tutorials/setup_minikube_in_github_actions.md b/site/content/en/docs/tutorials/setup_minikube_in_github_actions.md index c91030fd5f..100c2e38ed 100644 --- a/site/content/en/docs/tutorials/setup_minikube_in_github_actions.md +++ b/site/content/en/docs/tutorials/setup_minikube_in_github_actions.md @@ -1,6 +1,6 @@ --- title: "Setup minikube as CI step in github actions" -linkTitle: "minikube in github actions" +linkTitle: "Minikube in Github Actions" weight: 1 date: 2020-06-02 description: > diff --git a/site/content/en/docs/tutorials/telemetry.md b/site/content/en/docs/tutorials/telemetry.md index 55e16d4f02..b3dc9ab3a3 100644 --- a/site/content/en/docs/tutorials/telemetry.md +++ b/site/content/en/docs/tutorials/telemetry.md @@ -1,6 +1,6 @@ --- title: "Telemetry" -linkTitle: "telemetry" +linkTitle: "Telemetry" weight: 1 date: 2020-11-24 --- diff --git a/site/layouts/partials/sidebar-tree.html b/site/layouts/partials/sidebar-tree.html index 61ba2a9a81..1f04a94093 100644 --- a/site/layouts/partials/sidebar-tree.html +++ b/site/layouts/partials/sidebar-tree.html @@ -1,115 +1,101 @@ -{{/* minikube hack: temporarily forked from docsy/layouts/partials/sidebar-tree.html for hugo v0.69 compatibility */}} - -{{/* We cache this partial for bigger sites and set the active class client side. */}} -{{ $shouldDelayActive := ge (len .Site.Pages) 2000 }} -
+{{/* minikube hack: temporarily forked from +docsy/layouts/partials/sidebar-tree.html for hugo v0.69 compatibility */}} {{/* +We cache this partial for bigger sites and set the active class client side. +*/}} {{ $shouldDelayActive := ge (len .Site.Pages) 2000 }} +
{{ if not .Site.Params.ui.sidebar_search_disable }}
{{ partial "search-input.html" . }} - +
{{ end }}
- -{{ define "section-tree-nav-section" }} -{{ $s := .section }} -{{ $p := .page }} -{{ $shouldDelayActive := .delayActive }} -{{ $activeSection := eq $p.CurrentSection $s }} - -{{/* minikube hack: Override $showSection due to a Hugo upgrade bug */}} -{{ $showSection := false }} -{{ $expandSection := false }} -{{ $sid := $s.RelPermalink | anchorize }} -{{ $sectionParent := $s.Parent.Title | anchorize }} -{{ $csid := $p.CurrentSection.Title | anchorize }} - -{{ if $p.IsDescendant $s }} - - {{ $showSection = true }} -{{ else if eq $sectionParent "minikube" }} - - {{ $showSection = true }} -{{ else if eq $sectionParent "welcome" }} - - {{ $showSection = true }} -{{ else if eq $sectionParent "handbook" }} - - {{ $showSection = true }} -{{ else if eq $p.CurrentSection $s.Parent }} - - {{ $showSection = true }} -{{ else if $p.Parent.IsAncestor $s }} - - {{ if eq $s $p.CurrentSection }} - {{ $showSection = true }} - {{ end }} - -{{ end }} +{{ define "section-tree-nav-section" }} {{ $s := .section }} {{ $p := .page }} +{{ $shouldDelayActive := .delayActive }} {{ $activeSection := eq +$p.CurrentSection $s }} {{/* minikube hack: Override $showSection due to a Hugo +upgrade bug */}} {{ $showSection := false }} {{ $expandSection := false }} {{ +$sid := $s.RelPermalink | anchorize }} {{ $sectionParent := $s.Parent.Title | +anchorize }} {{ $csid := $p.CurrentSection.Title | anchorize }} {{ if +$p.IsDescendant $s }} + +{{ $showSection = true }} {{ else if eq $sectionParent "minikube" }} + +{{ $showSection = true }} {{ else if eq $sectionParent "welcome" }} + +{{ $showSection = true }} {{ else if eq $sectionParent "handbook" }} + +{{ $showSection = true }} {{ else if eq $p.CurrentSection $s.Parent }} + +{{ $showSection = true }} {{ else if $p.Parent.IsAncestor $s }} + +{{ if eq $s $p.CurrentSection }} {{ $showSection = true }} {{ end }} {{ end }} -{{/* end minikube hack */}} +{{/* end minikube hack */}} {{ $sid := $s.RelPermalink | anchorize }} {{ if +$showSection }} +