Skip to content

Commit 128bdfb

Browse files
tstrombergtstromberg
authored
Merge pull request #4674 from kubernetes/docsy2
Switch documentation site to docsy theme, add sample content
2 parents a05a26e + 1ba2cd8 commit 128bdfb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+6116
-6210
lines changed

‎.gitmodules

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
[submodule "site/themes/hugo-whisper-theme"]
2-
path = site/themes/hugo-whisper-theme
3-
url = https://github.com/jugglerx/hugo-whisper-theme.git
1+
[submodule "site/themes/docsy"]
2+
path = site/themes/docsy
3+
url = https://github.com/google/docsy.git

‎netlify.toml

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
[build]
22
base = "site/"
33
publish = "site/public/"
4-
command = "hugo"
4+
command = "pwd && cd themes/docsy && git submodule update -f --init && cd ../.. && hugo"
55

66
[build.environment]
7-
HUGO_VERSION = "0.55.0"
7+
HUGO_VERSION = "0.55.6"
88

99
[context.production.environment]
1010
HUGO_ENV = "production"
1111
HUGO_BASEURL = "https://minikube.sigs.k8s.io/"
1212

13-
[context.deploy-preview]
14-
command = "hugo --enableGitInfo --buildFuture -b $DEPLOY_PRIME_URL"
13+
#[context.deploy-preview]
14+
#command = "hugo --enableGitInfo --buildFuture -b $DEPLOY_PRIME_URL"
1515

16-
[context.branch-deploy]
17-
command = "hugo --enableGitInfo --buildFuture -b $DEPLOY_PRIME_URL"
16+
#[context.branch-deploy]
17+
#command = "hugo --enableGitInfo --buildFuture -b $DEPLOY_PRIME_URL"

‎pkg/minikube/extract/testdata/test.json

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
{
2+
"Hint: This is not a URL, come on.": "",
23
"Holy cow I'm in a loop!": "Something else",
3-
"This was a choice: %s": "Something"
4+
"This is a variable with a string assigned": "",
5+
"This was a choice: %s": "Something",
6+
"Wow another string: %s": ""
47
}

‎site/README.md

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
[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://gohugo.io/themes/installing-and-using-themes/).
2+
3+
This Docsy Example Project is hosted at [https://goldydocs.netlify.com/](https://goldydocs.netlify.com/).
4+
5+
You can find detailed theme instructions in the Docsy user guide: https://docsydocs.netlify.com/docs/
6+
7+
This is not an officially supported Google product. This project is currently maintained.
8+
9+
## Cloning the Docsy Example Project
10+
11+
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.
12+
13+
```bash
14+
git clone --recurse-submodules --depth 1 https://github.com/google/docsy-example.git
15+
cd docsy-example
16+
hugo server
17+
```
18+
19+
The theme is included as a Git submodule:
20+
21+
```bash
22+
▶ git submodule
23+
a053131a4ebf6a59e4e8834a42368e248d98c01d themes/docsy (heads/master)
24+
```
25+
26+
If you want to do SCSS edits and want to publish these, you need to install `PostCSS` (not needed for `hugo server`):
27+
28+
```bash
29+
npm install
30+
```
31+
32+
<!--### Cloning the Example from the Theme Project
33+
34+
35+
```bash
36+
git clone --recurse-submodules --depth 1 https://github.com/docsy.git
37+
cd tech-doc-hugo-theme/exampleSite
38+
HUGO_THEMESDIR="../.." hugo server
39+
```
40+
41+
42+
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:
43+
44+
```bash
45+
git subtree add --prefix exampleSite https://github.com/google/docsy.git master --squash
46+
```
47+
48+
To pull in changes, see `pull-deps.sh` script in the theme.-->
49+
50+
## Running the website locally
51+
52+
Once you've cloned the site repo, from the repo root folder, run:
53+
54+
```
55+
hugo server
56+
```

‎site/archetypes/default.md

-6
This file was deleted.

‎site/assets/scss/_variables_project.scss

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/*
2+
3+
Add styles or override variables from the theme here.
4+
5+
*/
6+
7+
$primary: #326DE6;

‎site/config.toml

+128-30
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,146 @@
11
title = "minikube"
22
baseURL = "https://minikube.sigs.k8s.io"
3-
languageCode = "en-us"
3+
enableRobotsTXT = true
44

5-
# code highlighting
6-
pygmentsCodeFences = true
7-
pygmentsCodefencesGuessSyntax = true
8-
pygmentsUseClasses = true
5+
# Hugo allows theme composition (and inheritance). The precedence is from left to right.
6+
theme = ["docsy"]
7+
8+
# Will give values to .Lastmod etc.
9+
enableGitInfo = true
910

11+
# Language settings
12+
contentDir = "content/en"
13+
defaultContentLanguage = "en"
14+
defaultContentLanguageInSubdir = false
15+
# Useful when translating.
16+
enableMissingTranslationPlaceholders = true
1017

11-
# unused
1218
disableKinds = ["taxonomy", "taxonomyTerm"]
1319

14-
themesDir = "themes"
15-
theme = "hugo-whisper-theme"
20+
# Highlighting config
21+
pygmentsCodeFences = true
22+
pygmentsUseClasses = false
23+
# Use the new Chroma Go highlighter in Hugo.
24+
pygmentsUseClassic = false
25+
#pygmentsOptions = "linenos=table"
26+
# See https://help.farbox.com/pygments.html
27+
pygmentsStyle = "tango"
28+
29+
# First one is picked as the Twitter card image if not set on page.
30+
#images = ["images/project-illustration.png"]
31+
32+
# Configure how URLs look like per section.
33+
[permalinks]
34+
blog = "/:section/:year/:month/:day/:slug/"
35+
36+
## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
37+
[blackfriday]
38+
plainIDAnchors = true
39+
hrefTargetBlank = true
40+
angledQuotes = false
41+
latexDashes = true
1642

17-
[[menu.main]]
18-
name = "Home"
19-
url = "/"
20-
weight = 1
43+
# Image processing configuration.
44+
[imaging]
45+
resampleFilter = "CatmullRom"
46+
quality = 75
47+
anchor = "smart"
2148

22-
[[menu.main]]
23-
name = "Docs"
24-
url = "/docs/"
25-
weight = 2
49+
[services]
50+
[services.googleAnalytics]
51+
# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
52+
#id = "UA-00000000-0"
53+
54+
# Language configuration
55+
56+
[languages]
57+
[languages.en]
58+
title = "minikube"
59+
description = "minikube is local Kubernetes"
60+
languageName = "English"
61+
# Weight used for sorting.
62+
weight = 1
63+
[languages.no]
64+
title = "minikube"
65+
description = "minikube er lokale Kubernetes"
66+
languageName ="Norsk"
67+
contentDir = "content/no"
68+
time_format_default = "02.01.2006"
69+
time_format_blog = "02.01.2006"
70+
71+
# Everything below this are Site Params
2672

2773
[params]
28-
google_analytics_id=""
29-
homepage_button_link = '/docs'
30-
homepage_button_text = 'Read The Docs'
31-
homepage_intro = 'minikube implements a local Kubernetes cluster on macOS, Linux, and Windows.'
32-
homepage_image = 'https://github.com/kubernetes/minikube/raw/master/images/start.jpg'
74+
copyright = "The Linux Foundation"
75+
privacy_policy = ""
76+
77+
# Menu title if your navbar has a versions selector to access old versions of your site.
78+
# This menu appears only if you have at least one [params.versions] set.
79+
version_menu = "Releases"
3380

34-
[params.homepage_meta_tags]
35-
meta_description = "minikube desc"
36-
meta_og_title = "minikube"
37-
meta_og_type = "website"
38-
meta_og_url = "https://minikube.sigs.k8s.io"
39-
meta_og_image = "https://raw.githubusercontent.com/JugglerX/hugo-whisper-theme/master/images/tn.png"
81+
# Repository configuration (URLs for in-page links to opening issues and suggesting changes)
82+
github_repo = "http://github.com/minikube/kubernetes"
83+
# An optional link to a related project repo. For example, the sibling repository where your product code lives.
84+
github_project_repo = ""
4085

41-
[params.logo]
42-
mobile = "https://github.com/kubernetes/minikube/raw/master/images/logo/logo.png"
43-
standard = "https://github.com/kubernetes/minikube/raw/master/images/logo/logo.png"
86+
# Specify a value here if your content directory is not in your repo's root directory
87+
github_subdir = "/site/content"
4488

89+
# Google Custom Search Engine ID. Remove or comment out to disable search.
90+
gcs_engine_id = "005331096405080631692:s7c4yfpw9sy"
4591

92+
# User interface configuration
93+
[params.ui]
94+
# Enable to show the side bar menu in its compact state.
95+
sidebar_menu_compact = false
96+
# Set to true to disable breadcrumb navigation.
97+
breadcrumb_disable = false
98+
# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
99+
sidebar_search_disable = false
100+
# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
101+
navbar_logo = true
46102

103+
# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
104+
# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
105+
# If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
106+
# add "hide_feedback: true" to the page's front matter.
107+
[params.ui.feedback]
108+
enable = true
109+
# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
110+
yes = 'Glad to hear it! Please <a href="https://github.com/kubernetes/minikube/issues/new">tell us how we can improve</a>.'
111+
no = 'Sorry to hear that. Please <a href="https://github.com/kubernetes/minikube/issues/new">tell us how we can improve</a>.'
47112

113+
[params.links]
114+
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
115+
[[params.links.user]]
116+
name = "User mailing list"
117+
url = "https://groups.google.com/forum/#!forum/minikube-users"
118+
icon = "fa fa-envelope"
119+
desc = "Discussion and help from your fellow users"
120+
[[params.links.user]]
121+
name ="Twitter"
122+
url = "https://example.org/twitter"
123+
icon = "fab fa-twitter"
124+
desc = "Follow us on Twitter to get the latest news!"
125+
[[params.links.user]]
126+
name = "Stack Overflow"
127+
url = "https://stackoverflow.com/questions/tagged/minikube"
128+
icon = "fab fa-stack-overflow"
129+
desc = "Practical questions and curated answers"
130+
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
131+
[[params.links.developer]]
132+
name = "GitHub"
133+
url = "https://github.com/kubernetes/minikube"
134+
icon = "fab fa-github"
135+
desc = "Development takes place here!"
136+
[[params.links.developer]]
137+
name = "Slack"
138+
url = "https://kubernetes.slack.com/messages/C1F5CT6Q1"
139+
icon = "fab fa-slack"
140+
desc = "Chat with other project developers"
141+
[[params.links.developer]]
142+
name = "Developer mailing list"
143+
url = "https://groups.google.com/forum/#!forum/minikube-dev"
144+
icon = "fa fa-envelope"
145+
desc = "Discuss development issues around the project"
48146

‎site/content/_index.md

-10
This file was deleted.

‎site/content/en/_index.html

+89
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
---
2+
title: "minikube"
3+
resources:
4+
- src: "logo.png"
5+
title: "logo"
6+
7+
- src: "start.jpg"
8+
title: "start"
9+
---
10+
{{< blocks/cover title="Welcome to minikube" image_anchor="top" height="full" color="orange" >}}
11+
<div class="mx-auto">
12+
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
13+
Read the docs! <i class="fas fa-arrow-alt-circle-right ml-2"></i>
14+
</a>
15+
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/docsy-example">
16+
Download <i class="fab fa-github ml-2 "></i>
17+
</a>
18+
<p class="lead mt-5">The local Kubernetes environment for macOS, Linux, and Windows.</p>
19+
<div class="mx-auto mt-5">
20+
{{< blocks/link-down color="info" >}}
21+
</div>
22+
</div>
23+
{{< /blocks/cover >}}
24+
25+
26+
{{% blocks/lead color="primary" %}}
27+
28+
minikube is a local Kubernetes environment focused on application developers.
29+
30+
{{< imgproc "start" Fit "730x239" >}}{{< /imgproc >}}
31+
32+
Kubernetes certified, mother approved.
33+
{{% /blocks/lead %}}
34+
35+
{{< blocks/section color="dark" >}}
36+
{{% blocks/feature icon="fa-lightbulb" title="Developer focused" %}}
37+
38+
with unique features, such as:
39+
40+
- [Addons](https://github.com/kubernetes/minikube/blob/master/docs/addons.md)
41+
- [LoadBalancer emulation](https://github.com/kubernetes/minikube/blob/master/docs/tunnel.md)
42+
- [Swappable container runtimes](https://github.com/kubernetes/minikube/blob/master/docs/alternative_runtimes.md)
43+
- [Integrated Dashboard](https://github.com/kubernetes/minikube/blob/master/docs/dashboard.md)
44+
- [Advanced Configuration](https://github.com/kubernetes/minikube/blob/master/docs/configuring_kubernetes.md)
45+
- [GPU support](https://github.com/kubernetes/minikube/blob/master/docs/gpu.md)
46+
- [Filesystem mounts](https://github.com/kubernetes/minikube/blob/master/docs/host_folder_mount.md)
47+
- Reusable Docker daemon
48+
{{% /blocks/feature %}}
49+
50+
51+
{{% blocks/feature icon="fab fa-twitter" title="Works everywhere" %}}
52+
A consistent environment, regardless of operating system or virtualization technology.
53+
54+
- Linux
55+
- macOS
56+
- Windows
57+
58+
{{% /blocks/feature %}}
59+
60+
61+
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/gohugoio/hugo" %}}
62+
We do a [Pull Request](https://github.com/gohugoio/hugo/pulls) contributions workflow on **GitHub**. New contributors are
63+
always welcome!
64+
{{% /blocks/feature %}}
65+
{{< /blocks/section >}}
66+
67+
68+
{{< blocks/section >}}
69+
<div class="col">
70+
<h1 class="text-center">Recent News</h1>
71+
TBD.
72+
</div>
73+
{{< /blocks/section >}}
74+
75+
76+
{{< blocks/section >}}
77+
<div class="col">
78+
<h1 class="text-center">Want more?</h1>
79+
80+
<div class="d-flex justify-content-center">
81+
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
82+
Read the docs!<i class="fas fa-arrow-alt-circle-right ml-2"></i>
83+
</a>
84+
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/docsy-example">
85+
Download <i class="fab fa-github ml-2 "></i>
86+
</a>
87+
</div>
88+
</div>
89+
{{< /blocks/section >}}

0 commit comments

Comments
 (0)