mirror of
https://github.com/kubernetes-sigs/kustomize.git
synced 2026-06-11 17:12:51 +00:00
Add the kustomize.io docsy template
This commit is contained in:
81
site/content/en/_index.html
Normal file
81
site/content/en/_index.html
Normal file
@@ -0,0 +1,81 @@
|
||||
+++
|
||||
title = "Kustomize"
|
||||
linkTitle = "Kustomize"
|
||||
|
||||
+++
|
||||
|
||||
{{< blocks/cover title="Kustomize" image_anchor="top" height="full" color="orange" >}}
|
||||
<div class="mx-auto">
|
||||
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/docs" >}}">
|
||||
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
|
||||
</a>
|
||||
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/kubernetes-sigs/kustomize/">
|
||||
Download <i class="fab fa-github ml-2 "></i>
|
||||
</a>
|
||||
<p class="lead mt-5">Kubernetes native configuration management</p>
|
||||
{{< blocks/link-down color="info" >}}
|
||||
</div>
|
||||
{{< /blocks/cover >}}
|
||||
|
||||
|
||||
{{% blocks/lead color="primary" %}}
|
||||
Goldydocs provides a single web UI providing visibility into porridge temperature, chair size, and bed softness metrics! You can even find out who's been eating **your** porridge.
|
||||
|
||||
(Sadly, Goldydocs isn't a real project, but you can use this site as an example to create your own real websites with [Docsy](http://docsy.dev))
|
||||
{{% /blocks/lead %}}
|
||||
|
||||
{{< blocks/section color="dark" >}}
|
||||
{{% blocks/feature icon="fa-lightbulb" title="New chair metrics!" %}}
|
||||
The Goldydocs UI now shows chair size metrics by default.
|
||||
|
||||
Please follow this space for updates!
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
|
||||
We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
|
||||
For announcement of latest features etc.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{< /blocks/section >}}
|
||||
|
||||
|
||||
{{< blocks/section >}}
|
||||
<div class="col">
|
||||
<h1 class="text-center">This is the second Section</h1>
|
||||
</div>
|
||||
|
||||
{{< /blocks/section >}}
|
||||
|
||||
|
||||
|
||||
{{< blocks/section >}}
|
||||
{{% blocks/feature icon="fab fa-app-store-ios" title="Download **from AppStore**" %}}
|
||||
Get the Goldydocs app!
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy-example" %}}
|
||||
We do a [Pull Request](https://github.com/google/docsy-example/pulls) contributions workflow on **GitHub**. New users are always welcome!
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/GoHugoIO" %}}
|
||||
For announcement of latest features etc.
|
||||
{{% /blocks/feature %}}
|
||||
|
||||
|
||||
{{< /blocks/section >}}
|
||||
|
||||
{{< blocks/section >}}
|
||||
|
||||
<div class="col-12">
|
||||
<h1 class="text-center">This is another Section</h1>
|
||||
</div>
|
||||
|
||||
{{< /blocks/section >}}
|
||||
13
site/content/en/blog/_index.md
Normal file
13
site/content/en/blog/_index.md
Normal file
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: "Docsy Blog"
|
||||
linkTitle: "Blog"
|
||||
menu:
|
||||
main:
|
||||
weight: 40
|
||||
---
|
||||
|
||||
|
||||
This is the **blog** section. It has two categories: News and Releases.
|
||||
|
||||
Files in these directories will be listed in reverse chronological order.
|
||||
|
||||
8
site/content/en/blog/news/_index.md
Normal file
8
site/content/en/blog/news/_index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
---
|
||||
title: "News About Docsy"
|
||||
linkTitle: "News"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
|
||||
BIN
site/content/en/blog/news/first-post/featured-sunset-get.png
Normal file
BIN
site/content/en/blog/news/first-post/featured-sunset-get.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 378 KiB |
46
site/content/en/blog/news/first-post/index.md
Normal file
46
site/content/en/blog/news/first-post/index.md
Normal file
@@ -0,0 +1,46 @@
|
||||
---
|
||||
date: 2018-10-06
|
||||
title: "Easy documentation with Docsy"
|
||||
linkTitle: "Announcing Docsy"
|
||||
description: "The Docsy Hugo theme lets project maintainers and contributors focus on content, not on reinventing a website infrastructure from scratch"
|
||||
author: Riona MacNamara ([@rionam](https://twitter.com/bepsays))
|
||||
resources:
|
||||
- src: "**.{png,jpg}"
|
||||
title: "Image #:counter"
|
||||
params:
|
||||
byline: "Photo: Riona MacNamara / CC-BY-CA"
|
||||
---
|
||||
|
||||
**This is a typical blog post that includes images.**
|
||||
|
||||
The front matter specifies the date of the blog post, its title, a short description that will be displayed on the blog landing page, and its author.
|
||||
|
||||
## Including images
|
||||
|
||||
Here's an image (`featured-sunset-get.png`) that includes a byline and a caption.
|
||||
|
||||
{{< imgproc sunset Fill "600x300" >}}
|
||||
Fetch and scale an image in the upcoming Hugo 0.43.
|
||||
{{< /imgproc >}}
|
||||
|
||||
The front matter of this post specifies properties to be assigned to all image resources:
|
||||
|
||||
```
|
||||
resources:
|
||||
- src: "**.{png,jpg}"
|
||||
title: "Image #:counter"
|
||||
params:
|
||||
byline: "Photo: Riona MacNamara / CC-BY-CA"
|
||||
```
|
||||
|
||||
To include the image in a page, specify its details like this:
|
||||
|
||||
```
|
||||
{{< imgproc sunset Fill "600x300" >}}
|
||||
Fetch and scale an image in the upcoming Hugo 0.43.
|
||||
{{< /imgproc >}}
|
||||
```
|
||||
|
||||
The image will be rendered at the size and byline specified in the front matter.
|
||||
|
||||
|
||||
245
site/content/en/blog/news/second-post.md
Executable file
245
site/content/en/blog/news/second-post.md
Executable file
@@ -0,0 +1,245 @@
|
||||
|
||||
---
|
||||
title: "The second blog post"
|
||||
linkTitle: "Second blog post"
|
||||
date: 2018-10-06
|
||||
description: >
|
||||
A short lead description about this content page. Text here can also be **bold** or _italic_ and can even be split over multiple paragraphs.
|
||||
---
|
||||
|
||||
Text can be **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com) should be blue with no underlines (unless hovered over).
|
||||
|
||||
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.
|
||||
|
||||
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.
|
||||
|
||||
> There should be no margin above this first sentence.
|
||||
>
|
||||
> Blockquotes should be a lighter gray with a border along the left side in the secondary color.
|
||||
>
|
||||
> There should be no margin below this final sentence.
|
||||
|
||||
## First Header
|
||||
|
||||
This is a normal paragraph following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
On big screens, paragraphs and headings should not take up the full container width, but we want tables, code blocks and similar to take the full width.
|
||||
|
||||
Lorem markdownum tuta hospes stabat; idem saxum facit quaterque repetito
|
||||
occumbere, oves novem gestit haerebat frena; qui. Respicit recurvam erat:
|
||||
pignora hinc reppulit nos **aut**, aptos, ipsa.
|
||||
|
||||
Meae optatos *passa est* Epiros utiliter *Talibus niveis*, hoc lata, edidit.
|
||||
Dixi ad aestum.
|
||||
|
||||
## Header 2
|
||||
|
||||
> This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Header 3
|
||||
|
||||
```
|
||||
This is a code block following a header.
|
||||
```
|
||||
|
||||
#### Header 4
|
||||
|
||||
* This is an unordered list following a header.
|
||||
* This is an unordered list following a header.
|
||||
* This is an unordered list following a header.
|
||||
|
||||
##### Header 5
|
||||
|
||||
1. This is an ordered list following a header.
|
||||
2. This is an ordered list following a header.
|
||||
3. This is an ordered list following a header.
|
||||
|
||||
###### Header 6
|
||||
|
||||
| What | Follows |
|
||||
|-----------|-----------------|
|
||||
| A table | A header |
|
||||
| A table | A header |
|
||||
| A table | A header |
|
||||
|
||||
----------------
|
||||
|
||||
There's a horizontal rule above and below this.
|
||||
|
||||
----------------
|
||||
|
||||
Here is an unordered list:
|
||||
|
||||
* Salt-n-Pepa
|
||||
* Bel Biv DeVoe
|
||||
* Kid 'N Play
|
||||
|
||||
And an ordered list:
|
||||
|
||||
1. Michael Jackson
|
||||
2. Michael Bolton
|
||||
3. Michael Bublé
|
||||
|
||||
And an unordered task list:
|
||||
|
||||
- [x] Create a sample markdown document
|
||||
- [x] Add task lists to it
|
||||
- [ ] Take a vacation
|
||||
|
||||
And a "mixed" task list:
|
||||
|
||||
- [ ] Steal underpants
|
||||
- ?
|
||||
- [ ] Profit!
|
||||
|
||||
And a nested list:
|
||||
|
||||
* Jackson 5
|
||||
* Michael
|
||||
* Tito
|
||||
* Jackie
|
||||
* Marlon
|
||||
* Jermaine
|
||||
* TMNT
|
||||
* Leonardo
|
||||
* Michelangelo
|
||||
* Donatello
|
||||
* Raphael
|
||||
|
||||
Definition lists can be used with Markdown syntax. Definition terms are bold.
|
||||
|
||||
Name
|
||||
: Godzilla
|
||||
|
||||
Born
|
||||
: 1952
|
||||
|
||||
Birthplace
|
||||
: Japan
|
||||
|
||||
Color
|
||||
: Green
|
||||
|
||||
|
||||
----------------
|
||||
|
||||
Tables should have bold headings and alternating shaded rows.
|
||||
|
||||
| Artist | Album | Year |
|
||||
|-------------------|-----------------|------|
|
||||
| Michael Jackson | Thriller | 1982 |
|
||||
| Prince | Purple Rain | 1984 |
|
||||
| Beastie Boys | License to Ill | 1986 |
|
||||
|
||||
If a table is too wide, it should scroll horizontally.
|
||||
|
||||
| Artist | Album | Year | Label | Awards | Songs |
|
||||
|-------------------|-----------------|------|-------------|----------|-----------|
|
||||
| Michael Jackson | Thriller | 1982 | Epic Records | Grammy Award for Album of the Year, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Selling Album, Grammy Award for Best Engineered Album, Non-Classical | Wanna Be Startin' Somethin', Baby Be Mine, The Girl Is Mine, Thriller, Beat It, Billie Jean, Human Nature, P.Y.T. (Pretty Young Thing), The Lady in My Life |
|
||||
| Prince | Purple Rain | 1984 | Warner Brothers Records | Grammy Award for Best Score Soundtrack for Visual Media, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Soundtrack/Cast Recording, Grammy Award for Best Rock Performance by a Duo or Group with Vocal | Let's Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I'm a Star, Purple Rain |
|
||||
| Beastie Boys | License to Ill | 1986 | Mercury Records | noawardsbutthistablecelliswide | Rhymin & Stealin, The New Style, She's Crafty, Posse in Effect, Slow Ride, Girls, (You Gotta) Fight for Your Right, No Sleep Till Brooklyn, Paul Revere, Hold It Now, Hit It, Brass Monkey, Slow and Low, Time to Get Ill |
|
||||
|
||||
----------------
|
||||
|
||||
Code snippets like `var foo = "bar";` can be shown inline.
|
||||
|
||||
Also, `this should vertically align` ~~`with this`~~ ~~and this~~.
|
||||
|
||||
Code can also be shown in a block element.
|
||||
|
||||
```
|
||||
foo := "bar";
|
||||
bar := "foo";
|
||||
```
|
||||
|
||||
Code can also use syntax highlighting.
|
||||
|
||||
```go
|
||||
func main() {
|
||||
input := `var foo = "bar";`
|
||||
|
||||
lexer := lexers.Get("javascript")
|
||||
iterator, _ := lexer.Tokenise(nil, input)
|
||||
style := styles.Get("github")
|
||||
formatter := html.New(html.WithLineNumbers())
|
||||
|
||||
var buff bytes.Buffer
|
||||
formatter.Format(&buff, style, iterator)
|
||||
|
||||
fmt.Println(buff.String())
|
||||
}
|
||||
```
|
||||
|
||||
```
|
||||
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
|
||||
```
|
||||
|
||||
Inline code inside table cells should still be distinguishable.
|
||||
|
||||
| Language | Code |
|
||||
|-------------|--------------------|
|
||||
| Javascript | `var foo = "bar";` |
|
||||
| Ruby | `foo = "bar"{` |
|
||||
|
||||
----------------
|
||||
|
||||
Small images should be shown at their actual size.
|
||||
|
||||

|
||||
|
||||
Large images should always scale down and fit in the content container.
|
||||
|
||||

|
||||
|
||||
## Components
|
||||
|
||||
### Alerts
|
||||
|
||||
{{< alert >}}This is an alert.{{< /alert >}}
|
||||
{{< alert title="Note:" >}}This is an alert with a title.{{< /alert >}}
|
||||
{{< alert type="success" >}}This is a successful alert.{{< /alert >}}
|
||||
{{< alert type="warning" >}}This is a warning!{{< /alert >}}
|
||||
{{< alert type="warning" title="Warning!" >}}This is a warning with a title!{{< /alert >}}
|
||||
|
||||
|
||||
## Sizing
|
||||
|
||||
Add some sections here to see how the ToC looks like. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Parameters available
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Using pixels
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Using rem
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
## Memory
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### RAM to use
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### More is better
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Used RAM
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
|
||||
|
||||
```
|
||||
This is the final element on the page and there should be no margin below this.
|
||||
```
|
||||
8
site/content/en/blog/releases/_index.md
Normal file
8
site/content/en/blog/releases/_index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
|
||||
---
|
||||
title: "New Releases"
|
||||
linkTitle: "Releases"
|
||||
weight: 20
|
||||
---
|
||||
|
||||
|
||||
245
site/content/en/blog/releases/in-depth-monoliths-detailed-spec.md
Executable file
245
site/content/en/blog/releases/in-depth-monoliths-detailed-spec.md
Executable file
@@ -0,0 +1,245 @@
|
||||
|
||||
---
|
||||
title: "Another Great Release"
|
||||
linkTitle: "Release New Features"
|
||||
date: 2018-01-04
|
||||
description: >
|
||||
A short lead description about this content page. Text here can also be **bold** or _italic_ and can even be split over multiple paragraphs.
|
||||
---
|
||||
|
||||
Text can be **bold**, _italic_, or ~~strikethrough~~. [Links](https://github.com) should be blue with no underlines (unless hovered over).
|
||||
|
||||
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.
|
||||
|
||||
There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs. There should be whitespace between paragraphs.
|
||||
|
||||
> There should be no margin above this first sentence.
|
||||
>
|
||||
> Blockquotes should be a lighter gray with a border along the left side in the secondary color.
|
||||
>
|
||||
> There should be no margin below this final sentence.
|
||||
|
||||
## First Header
|
||||
|
||||
This is a normal paragraph following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
On big screens, paragraphs and headings should not take up the full container width, but we want tables, code blocks and similar to take the full width.
|
||||
|
||||
Lorem markdownum tuta hospes stabat; idem saxum facit quaterque repetito
|
||||
occumbere, oves novem gestit haerebat frena; qui. Respicit recurvam erat:
|
||||
pignora hinc reppulit nos **aut**, aptos, ipsa.
|
||||
|
||||
Meae optatos *passa est* Epiros utiliter *Talibus niveis*, hoc lata, edidit.
|
||||
Dixi ad aestum.
|
||||
|
||||
## Header 2
|
||||
|
||||
> This is a blockquote following a header. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Header 3
|
||||
|
||||
```
|
||||
This is a code block following a header.
|
||||
```
|
||||
|
||||
#### Header 4
|
||||
|
||||
* This is an unordered list following a header.
|
||||
* This is an unordered list following a header.
|
||||
* This is an unordered list following a header.
|
||||
|
||||
##### Header 5
|
||||
|
||||
1. This is an ordered list following a header.
|
||||
2. This is an ordered list following a header.
|
||||
3. This is an ordered list following a header.
|
||||
|
||||
###### Header 6
|
||||
|
||||
| What | Follows |
|
||||
|-----------|-----------------|
|
||||
| A table | A header |
|
||||
| A table | A header |
|
||||
| A table | A header |
|
||||
|
||||
----------------
|
||||
|
||||
There's a horizontal rule above and below this.
|
||||
|
||||
----------------
|
||||
|
||||
Here is an unordered list:
|
||||
|
||||
* Salt-n-Pepa
|
||||
* Bel Biv DeVoe
|
||||
* Kid 'N Play
|
||||
|
||||
And an ordered list:
|
||||
|
||||
1. Michael Jackson
|
||||
2. Michael Bolton
|
||||
3. Michael Bublé
|
||||
|
||||
And an unordered task list:
|
||||
|
||||
- [x] Create a sample markdown document
|
||||
- [x] Add task lists to it
|
||||
- [ ] Take a vacation
|
||||
|
||||
And a "mixed" task list:
|
||||
|
||||
- [ ] Steal underpants
|
||||
- ?
|
||||
- [ ] Profit!
|
||||
|
||||
And a nested list:
|
||||
|
||||
* Jackson 5
|
||||
* Michael
|
||||
* Tito
|
||||
* Jackie
|
||||
* Marlon
|
||||
* Jermaine
|
||||
* TMNT
|
||||
* Leonardo
|
||||
* Michelangelo
|
||||
* Donatello
|
||||
* Raphael
|
||||
|
||||
Definition lists can be used with Markdown syntax. Definition terms are bold.
|
||||
|
||||
Name
|
||||
: Godzilla
|
||||
|
||||
Born
|
||||
: 1952
|
||||
|
||||
Birthplace
|
||||
: Japan
|
||||
|
||||
Color
|
||||
: Green
|
||||
|
||||
|
||||
----------------
|
||||
|
||||
Tables should have bold headings and alternating shaded rows.
|
||||
|
||||
| Artist | Album | Year |
|
||||
|-------------------|-----------------|------|
|
||||
| Michael Jackson | Thriller | 1982 |
|
||||
| Prince | Purple Rain | 1984 |
|
||||
| Beastie Boys | License to Ill | 1986 |
|
||||
|
||||
If a table is too wide, it should scroll horizontally.
|
||||
|
||||
| Artist | Album | Year | Label | Awards | Songs |
|
||||
|-------------------|-----------------|------|-------------|----------|-----------|
|
||||
| Michael Jackson | Thriller | 1982 | Epic Records | Grammy Award for Album of the Year, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Selling Album, Grammy Award for Best Engineered Album, Non-Classical | Wanna Be Startin' Somethin', Baby Be Mine, The Girl Is Mine, Thriller, Beat It, Billie Jean, Human Nature, P.Y.T. (Pretty Young Thing), The Lady in My Life |
|
||||
| Prince | Purple Rain | 1984 | Warner Brothers Records | Grammy Award for Best Score Soundtrack for Visual Media, American Music Award for Favorite Pop/Rock Album, American Music Award for Favorite Soul/R&B Album, Brit Award for Best Soundtrack/Cast Recording, Grammy Award for Best Rock Performance by a Duo or Group with Vocal | Let's Go Crazy, Take Me With U, The Beautiful Ones, Computer Blue, Darling Nikki, When Doves Cry, I Would Die 4 U, Baby I'm a Star, Purple Rain |
|
||||
| Beastie Boys | License to Ill | 1986 | Mercury Records | noawardsbutthistablecelliswide | Rhymin & Stealin, The New Style, She's Crafty, Posse in Effect, Slow Ride, Girls, (You Gotta) Fight for Your Right, No Sleep Till Brooklyn, Paul Revere, Hold It Now, Hit It, Brass Monkey, Slow and Low, Time to Get Ill |
|
||||
|
||||
----------------
|
||||
|
||||
Code snippets like `var foo = "bar";` can be shown inline.
|
||||
|
||||
Also, `this should vertically align` ~~`with this`~~ ~~and this~~.
|
||||
|
||||
Code can also be shown in a block element.
|
||||
|
||||
```
|
||||
foo := "bar";
|
||||
bar := "foo";
|
||||
```
|
||||
|
||||
Code can also use syntax highlighting.
|
||||
|
||||
```go
|
||||
func main() {
|
||||
input := `var foo = "bar";`
|
||||
|
||||
lexer := lexers.Get("javascript")
|
||||
iterator, _ := lexer.Tokenise(nil, input)
|
||||
style := styles.Get("github")
|
||||
formatter := html.New(html.WithLineNumbers())
|
||||
|
||||
var buff bytes.Buffer
|
||||
formatter.Format(&buff, style, iterator)
|
||||
|
||||
fmt.Println(buff.String())
|
||||
}
|
||||
```
|
||||
|
||||
```
|
||||
Long, single-line code blocks should not wrap. They should horizontally scroll if they are too long. This line should be long enough to demonstrate this.
|
||||
```
|
||||
|
||||
Inline code inside table cells should still be distinguishable.
|
||||
|
||||
| Language | Code |
|
||||
|-------------|--------------------|
|
||||
| Javascript | `var foo = "bar";` |
|
||||
| Ruby | `foo = "bar"{` |
|
||||
|
||||
----------------
|
||||
|
||||
Small images should be shown at their actual size.
|
||||
|
||||

|
||||
|
||||
Large images should always scale down and fit in the content container.
|
||||
|
||||

|
||||
|
||||
## Components
|
||||
|
||||
### Alerts
|
||||
|
||||
{{< alert >}}This is an alert.{{< /alert >}}
|
||||
{{< alert title="Note:" >}}This is an alert with a title.{{< /alert >}}
|
||||
{{< alert type="success" >}}This is a successful alert.{{< /alert >}}
|
||||
{{< alert type="warning" >}}This is a warning!{{< /alert >}}
|
||||
{{< alert type="warning" title="Warning!" >}}This is a warning with a title!{{< /alert >}}
|
||||
|
||||
|
||||
## Sizing
|
||||
|
||||
Add some sections here to see how the ToC looks like. Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Parameters available
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Using pixels
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Using rem
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
## Memory
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### RAM to use
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### More is better
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
### Used RAM
|
||||
|
||||
Bacon ipsum dolor sit amet t-bone doner shank drumstick, pork belly porchetta chuck sausage brisket ham hock rump pig. Chuck kielbasa leberkas, pork bresaola ham hock filet mignon cow shoulder short ribs biltong.
|
||||
|
||||
|
||||
|
||||
```
|
||||
This is the final element on the page and there should be no margin below this.
|
||||
```
|
||||
8
site/content/en/community/_index.md
Normal file
8
site/content/en/community/_index.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: Community
|
||||
menu:
|
||||
main:
|
||||
weight: 20
|
||||
---
|
||||
|
||||
<!--add blocks of content here to add more sections to the community page -->
|
||||
23
site/content/en/contribute/_index.md
Normal file
23
site/content/en/contribute/_index.md
Normal file
@@ -0,0 +1,23 @@
|
||||
|
||||
---
|
||||
title: "Contribute"
|
||||
linkTitle: "Contribute"
|
||||
menu:
|
||||
main:
|
||||
weight: 30
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This is a placeholder page that shows you how to use this template site.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
|
||||
This section is where the user documentation for your project lives - all the information your users need to understand and successfully use your project.
|
||||
|
||||
For large documentation sets we recommend adding content under the headings in this section, though if some or all of them don’t apply to your project feel free to remove them or add your own. You can see an example of a smaller Docsy documentation site in the [Docsy User Guide](https://docsy.dev/docs/), which lives in the [Docsy theme repo](https://github.com/google/docsy/tree/master/userguide) if you'd like to copy its docs section.
|
||||
|
||||
Other content such as marketing material, case studies, and community updates should live in the [About](/about/) and [Community](/community/) pages.
|
||||
|
||||
Find out how to use the Docsy theme in the [Docsy User Guide](https://docsy.dev/docs/). You can learn more about how to organize your documentation (and how we organized this site) in [Organizing Your Content](https://docsy.dev/docs/best-practices/organizing-content/).
|
||||
|
||||
|
||||
11
site/content/en/docs/Concepts/_index.md
Normal file
11
site/content/en/docs/Concepts/_index.md
Normal file
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: "Concepts"
|
||||
linkTitle: "Concepts"
|
||||
weight: 3
|
||||
description: >
|
||||
What does your user need to understand about your project in order to use it - or potentially contribute to it?
|
||||
---
|
||||
|
||||
Might be nice to have some of those pictures from
|
||||
|
||||
|
||||
7
site/content/en/docs/Concepts/bases.md
Normal file
7
site/content/en/docs/Concepts/bases.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Bases"
|
||||
linkTitle: "Bases"
|
||||
weight: 20
|
||||
description: >
|
||||
What is a base?
|
||||
---
|
||||
7
site/content/en/docs/Concepts/components.md
Normal file
7
site/content/en/docs/Concepts/components.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Components"
|
||||
linkTitle: "Components"
|
||||
weight: 50
|
||||
description: >
|
||||
What is a component?
|
||||
---
|
||||
7
site/content/en/docs/Concepts/functions.md
Normal file
7
site/content/en/docs/Concepts/functions.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Functions"
|
||||
linkTitle: "Functions"
|
||||
weight: 60
|
||||
description: >
|
||||
What is a function?
|
||||
---
|
||||
7
site/content/en/docs/Concepts/generator.md
Normal file
7
site/content/en/docs/Concepts/generator.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Generators"
|
||||
linkTitle: "Generators"
|
||||
weight: 30
|
||||
description: >
|
||||
What is a generator?
|
||||
---
|
||||
7
site/content/en/docs/Concepts/kustomize_file.md
Normal file
7
site/content/en/docs/Concepts/kustomize_file.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Kustomize File"
|
||||
linkTitle: "Kustomize File"
|
||||
weight: 10
|
||||
description: >
|
||||
What is the kustomize file?
|
||||
---
|
||||
7
site/content/en/docs/Concepts/transformers.md
Normal file
7
site/content/en/docs/Concepts/transformers.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Transformers"
|
||||
linkTitle: "Transformers"
|
||||
weight: 40
|
||||
description: >
|
||||
What is a base?
|
||||
---
|
||||
7
site/content/en/docs/Getting started/_index.md
Normal file
7
site/content/en/docs/Getting started/_index.md
Normal file
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: "Getting Started"
|
||||
linkTitle: "Getting Started"
|
||||
weight: 2
|
||||
description: >
|
||||
What does your user need to know to try your project?
|
||||
---
|
||||
66
site/content/en/docs/Getting started/first_kustomization.md
Normal file
66
site/content/en/docs/Getting started/first_kustomization.md
Normal file
@@ -0,0 +1,66 @@
|
||||
---
|
||||
title: "Creating Your First Kustomization"
|
||||
linkTitle: "Creating Your First Kustomization"
|
||||
date: 2022-02-27
|
||||
weight: 20
|
||||
description: >
|
||||
A simple project example to get you familiar with the concepts
|
||||
---
|
||||
|
||||
We're going to use kustomize to deploy an nginx instance into our Kubernetes cluster.
|
||||
|
||||
## Creating the directory structure
|
||||
|
||||
Let's firt create a directory to store our kustomize project.
|
||||
```bash
|
||||
mkdir kustomize-nginx && cd kustomize-nginx
|
||||
```
|
||||
Create a `base` folder:
|
||||
```bash
|
||||
mkdir base
|
||||
```
|
||||
Inside this folder we will create two files:
|
||||
* `kustomization.yaml` - the configuration file for kustomize
|
||||
* `deployment.yaml` - the definition for our nginx deployment
|
||||
|
||||
`kustomization.yaml`
|
||||
```bash
|
||||
cat <<'EOF' >base/kustomization.yaml
|
||||
apiVersion: kustomize.config.k8s.io/v1beta1
|
||||
kind: Kustomization
|
||||
metadata:
|
||||
name: kustomize-nginx
|
||||
|
||||
resources:
|
||||
- deployment.yaml
|
||||
EOF
|
||||
```
|
||||
The file defines the `apiVersion`, the `kind` and the `resources` it manages.
|
||||
|
||||
`deployment.yaml`
|
||||
```bash
|
||||
cat <<'EOF' >base/deployment.yaml
|
||||
apiVersion: apps/v1
|
||||
kind: Deployment
|
||||
metadata:
|
||||
name: nginx
|
||||
labels:
|
||||
app: nginx
|
||||
spec:
|
||||
replicas: 1
|
||||
selector:
|
||||
matchLabels:
|
||||
app: nginx
|
||||
template:
|
||||
metadata:
|
||||
labels:
|
||||
app: nginx
|
||||
spec:
|
||||
containers:
|
||||
- name: nginx
|
||||
image: nginx:latest
|
||||
ports:
|
||||
- containerPort: 80
|
||||
EOF
|
||||
```
|
||||
TBC...
|
||||
97
site/content/en/docs/Getting started/installation.md
Normal file
97
site/content/en/docs/Getting started/installation.md
Normal file
@@ -0,0 +1,97 @@
|
||||
---
|
||||
title: "Install Kustomize"
|
||||
linkTitle: "Install Kustomize"
|
||||
date: 2022-02-27
|
||||
weight: 10
|
||||
description: >
|
||||
Installing Kustomize
|
||||
---
|
||||
|
||||
Kustomize can be installed in a variety of ways.
|
||||
|
||||
## Binaries
|
||||
Binaries are available for Linux, MacOS and Windows, across a variety of architectures.
|
||||
|
||||
You can see the full list of releases here on the [Github releases page](https://github.com/kubernetes-sigs/kustomize/releases).
|
||||
|
||||
### Quick install
|
||||
Get the latest build of Kustomize for your platform.
|
||||
```bash
|
||||
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" | bash
|
||||
```
|
||||
You can also pass optional `version` and `target_dir` arguments to the script:
|
||||
```bash
|
||||
curl -s "https://raw.githubusercontent.com/kubernetes-sigs/kustomize/master/hack/install_kustomize.sh" 4.4.1 $HOME/bin | bash
|
||||
```
|
||||
|
||||
❗**This script doesn’t work for ARM architecture**. If you want to install ARM binaries, please refer to the [releases page](https://github.com/kubernetes-sigs/kustomize/releases).
|
||||
|
||||
## Packages
|
||||
Kustomize is also available in some package repositories.
|
||||
|
||||
### Debian/Ubuntu
|
||||
```bash
|
||||
sudo apt-get install kustomize
|
||||
```
|
||||
### Arch
|
||||
```bash
|
||||
pacman -S kustomize
|
||||
```
|
||||
|
||||
### Mac
|
||||
[Homebrew](https://brew.sh/):
|
||||
```bash
|
||||
brew install kustomize
|
||||
```
|
||||
|
||||
[MacPorts](https://www.macports.org/):
|
||||
```bash
|
||||
sudo port install kustomize
|
||||
```
|
||||
|
||||
### Windows
|
||||
[Chocolatey](https://community.chocolatey.org/packages/kustomize)
|
||||
```bash
|
||||
choco install kustomize
|
||||
```
|
||||
|
||||
## Docker
|
||||
Docker images for kustomize are published on the [GCR Container Registry](https://console.cloud.google.com/gcr/images/k8s-artifacts-prod/US/kustomize/kustomize).
|
||||
```bash
|
||||
docker run k8s.gcr.io/kustomize/kustomize:v4.5.1 version
|
||||
```
|
||||
|
||||
## go get
|
||||
<!--
|
||||
TODO: is this still the way to do this? v3 seems old and my go module knowledge isn't great
|
||||
-->
|
||||
Requires [Go](https://go.dev/) to be installed.
|
||||
```bash
|
||||
GOBIN=$(pwd)/ GO111MODULE=on go get sigs.k8s.io/kustomize/kustomize/v3
|
||||
```
|
||||
|
||||
## Source
|
||||
<!--
|
||||
TODO: once again here, are these instructions up-to-date? We probably should bump to a later version of kustomize but I'm also not sure if these go env variables are modern practice
|
||||
-->
|
||||
Clone the kustomize Github repo and build using go.
|
||||
```bash
|
||||
# Need go 1.13 or higher
|
||||
unset GOPATH
|
||||
# see https://golang.org/doc/go1.13#modules
|
||||
unset GO111MODULES
|
||||
|
||||
# clone the repo
|
||||
git clone git@github.com:kubernetes-sigs/kustomize.git
|
||||
# get into the repo root
|
||||
cd kustomize
|
||||
|
||||
# Optionally checkout a particular tag if you don't
|
||||
# want to build at head
|
||||
git checkout kustomize/v3.2.3
|
||||
|
||||
# build the binary
|
||||
(cd kustomize; go install .)
|
||||
|
||||
# run it
|
||||
~/go/bin/kustomize version
|
||||
113
site/content/en/docs/Overview/_index.md
Normal file
113
site/content/en/docs/Overview/_index.md
Normal file
@@ -0,0 +1,113 @@
|
||||
---
|
||||
title: "Overview"
|
||||
linkTitle: "Overview"
|
||||
weight: 1
|
||||
description: >
|
||||
Introduction to Kustomize.
|
||||
---
|
||||
|
||||
Kustomize provides a solution for customizing Kubernetes resource configuration free from templates and DSLs.
|
||||
|
||||
Kustomize lets you customize raw, template-free YAML files for multiple purposes, leaving the original YAML untouched and usable as is.
|
||||
|
||||
Kustomize targets kubernetes; it understands and can patch kubernetes style API objects. It’s like make, in that what it does is declared in a file, and it’s like sed, in that it emits edited text.
|
||||
|
||||
## Usage
|
||||
|
||||
### 1) Make a `kustomization` file
|
||||
|
||||
In some directory containing your YAML `resource`
|
||||
files (deployments, services, configmaps, etc.), create a
|
||||
`kustomization` file.
|
||||
|
||||
This file should declare those resources, and any
|
||||
customization to apply to them, e.g. _add a common
|
||||
label_.
|
||||
|
||||
File structure:
|
||||
|
||||
```
|
||||
~/someApp
|
||||
├── deployment.yaml
|
||||
├── kustomization.yaml
|
||||
└── service.yaml
|
||||
```
|
||||
|
||||
The resources in this directory could be a fork of
|
||||
someone else's configuration. If so, you can easily
|
||||
rebase from the source material to capture
|
||||
improvements, because you don't modify the resources
|
||||
directly.
|
||||
|
||||
Generate customized YAML with:
|
||||
|
||||
```
|
||||
kustomize build ~/someApp
|
||||
```
|
||||
|
||||
The YAML can be directly `applied` to a cluster:
|
||||
|
||||
```
|
||||
kustomize build ~/someApp | kubectl apply -f -
|
||||
```
|
||||
|
||||
|
||||
### 2) Create `variants` using `overlays`
|
||||
|
||||
Manage traditional `variants` of a configuration - like
|
||||
_development_, _staging_ and _production_ - using
|
||||
`overlays` that modify a common `base`.
|
||||
|
||||
File structure:
|
||||
```
|
||||
~/someApp
|
||||
├── base
|
||||
│ ├── deployment.yaml
|
||||
│ ├── kustomization.yaml
|
||||
│ └── service.yaml
|
||||
└── overlays
|
||||
├── development
|
||||
│ ├── cpu_count.yaml
|
||||
│ ├── kustomization.yaml
|
||||
│ └── replica_count.yaml
|
||||
└── production
|
||||
├── cpu_count.yaml
|
||||
├── kustomization.yaml
|
||||
└── replica_count.yaml
|
||||
```
|
||||
|
||||
Take the work from step (1) above, move it into a
|
||||
`someApp` subdirectory called `base`, then
|
||||
place overlays in a sibling directory.
|
||||
|
||||
An overlay is just another kustomization, referring to
|
||||
the base, and referring to patches to apply to that
|
||||
base.
|
||||
|
||||
This arrangement makes it easy to manage your
|
||||
configuration with `git`. The base could have files
|
||||
from an upstream repository managed by someone else.
|
||||
The overlays could be in a repository you own.
|
||||
Arranging the repo clones as siblings on disk avoids
|
||||
the need for git submodules (though that works fine, if
|
||||
you are a submodule fan).
|
||||
|
||||
Generate YAML with
|
||||
|
||||
```sh
|
||||
kustomize build ~/someApp/overlays/production
|
||||
```
|
||||
|
||||
The YAML can be directly `applied` to a cluster:
|
||||
|
||||
```sh
|
||||
kustomize build ~/someApp/overlays/production | kubectl apply -f -
|
||||
```
|
||||
|
||||
## Where should I go next?
|
||||
|
||||
Give your users next steps from the Overview. For example:
|
||||
|
||||
* [Getting Started](/docs/getting-started/): Get started with $project
|
||||
* [Examples](/docs/examples/): Check out some example code!
|
||||
|
||||
14
site/content/en/docs/Reference/_index.md
Normal file
14
site/content/en/docs/Reference/_index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: "Reference"
|
||||
linkTitle: "Reference"
|
||||
weight: 9
|
||||
description: >
|
||||
Low level reference docs for your project.
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This is a placeholder page that shows you how to use this template site.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
If your project has an API, configuration, or other reference - anything that users need to look up that’s at an even lower level than a single task - put (or link to it) here. You can serve and link to generated reference docs created using Doxygen,
|
||||
Javadoc, or other doc generation tools by putting them in your `static/` directory. Find out more in [Adding static content](https://docsy.dev/docs/adding-content/content/#adding-static-content). For OpenAPI reference, Docsy also provides a [Swagger UI layout and shortcode](https://www.docsy.dev/docs/adding-content/shortcodes/#swaggerui) that renders [Swagger UI](https://swagger.io/tools/swagger-ui/) using any OpenAPI YAML or JSON file as source.
|
||||
8
site/content/en/docs/Reference/glossary.md
Normal file
8
site/content/en/docs/Reference/glossary.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Glossary"
|
||||
linkTitle: "Glossary"
|
||||
weight: 3
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
Definitions of the terminology used when interacting with kustomize
|
||||
---
|
||||
8
site/content/en/docs/Reference/kustomize_cli.md
Normal file
8
site/content/en/docs/Reference/kustomize_cli.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "kustomize CLI"
|
||||
linkTitle: "kustomize CLI"
|
||||
weight: 2
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
Reference for the kustomize CLI
|
||||
---
|
||||
8
site/content/en/docs/Reference/kustomize_yaml.md
Normal file
8
site/content/en/docs/Reference/kustomize_yaml.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "kustomize.yaml"
|
||||
linkTitle: "kustomize.yaml"
|
||||
weight: 1
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
Reference for the kustomize.yaml file
|
||||
---
|
||||
25
site/content/en/docs/Tasks/_index.md
Executable file
25
site/content/en/docs/Tasks/_index.md
Executable file
@@ -0,0 +1,25 @@
|
||||
|
||||
---
|
||||
title: "Core Tasks"
|
||||
linkTitle: "Core Tasks"
|
||||
weight: 4
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
What can your user do with your project?
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This is a placeholder page that shows you how to use this template site.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
Think about your project’s features and use cases. Use these to choose your core tasks. Each granular use case (enable x, configure y) should have a corresponding tasks page or tasks page section. Users should be able to quickly refer to your core tasks when they need to find out how to do one specific thing, rather than having to look for the instructions in a bigger tutorial or example. Think of your tasks pages as a cookbook with different procedures your users can combine to create something more substantial.
|
||||
|
||||
You can give each task a page, or you can group related tasks together in a page, such as tasks related to a particular feature. As well as grouping related tasks in single pages, you can also group task pages in nested folders with an index page as an overview, as seen in this example site. Or if you have a small docset like the [Docsy User Guide](https://docsy.dev/docs/) with no Tutorials or Concepts pages, consider adding your feature-specific pages at the top level of your docs rather than in a Tasks section.
|
||||
|
||||
Each task should give the user
|
||||
|
||||
* The prerequisites for this task, if any (this can be specified at the top of a multi-task page if they're the same for all the page's tasks. "All these tasks assume that you understand....and that you have already....").
|
||||
* What this task accomplishes.
|
||||
* Instructions for the task. If it involves editing a file, running a command, or writing code, provide code-formatted example snippets to show the user what to do! If there are multiple steps, provide them as a numbered list.
|
||||
* If appropriate, links to related concept, tutorial, or example pages.
|
||||
|
||||
8
site/content/en/docs/Tasks/configmaps_and_secrets.md
Normal file
8
site/content/en/docs/Tasks/configmaps_and_secrets.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "ConfigMaps and Secrets"
|
||||
linkTitle: "ConfigMaps and Secrets"
|
||||
weight: 3
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
Working with ConfigMaps and Secrets
|
||||
---
|
||||
8
site/content/en/docs/Tasks/labels_and_annotations.md
Normal file
8
site/content/en/docs/Tasks/labels_and_annotations.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Labels and Annotations"
|
||||
linkTitle: "Labels and Annotations"
|
||||
weight: 2
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
Working with Labels and Annotations
|
||||
---
|
||||
8
site/content/en/docs/Tasks/namespaces_and_names.md
Normal file
8
site/content/en/docs/Tasks/namespaces_and_names.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Namespaces and Names"
|
||||
linkTitle: "Namespaces and Names"
|
||||
weight: 1
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
Working with Namespaces and Names
|
||||
---
|
||||
16
site/content/en/docs/Tutorials/_index.md
Executable file
16
site/content/en/docs/Tutorials/_index.md
Executable file
@@ -0,0 +1,16 @@
|
||||
|
||||
---
|
||||
title: "Tutorials"
|
||||
linkTitle: "Tutorials"
|
||||
weight: 6
|
||||
date: 2017-01-04
|
||||
description: >
|
||||
Show your user how to work through some end to end examples.
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This is a placeholder page that shows you how to use this template site.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
Tutorials are **complete worked examples** made up of **multiple tasks** that guide the user through a relatively simple but realistic scenario: building an application that uses some of your project’s features, for example. If you have already created some Examples for your project you can base Tutorials on them. This section is **optional**. However, remember that although you may not need this section at first, having tutorials can be useful to help your users engage with your example code, especially if there are aspects that need more explanation than you can easily provide in code comments.
|
||||
|
||||
8
site/content/en/docs/Tutorials/custom_application.md
Normal file
8
site/content/en/docs/Tutorials/custom_application.md
Normal file
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Deploying a Custom Application"
|
||||
linkTitle: "Deploying a Custom Application"
|
||||
weight: 1
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
How to use Kustomize to deploy an in-house application
|
||||
---
|
||||
@@ -0,0 +1,8 @@
|
||||
---
|
||||
title: "Deploying an Off-The-Shelf Application"
|
||||
linkTitle: "Deploying an Off-The-Shelf Application"
|
||||
weight: 1
|
||||
date: 2017-01-05
|
||||
description: >
|
||||
How to use Kustomize to deploy a third-party application
|
||||
---
|
||||
23
site/content/en/docs/_index.md
Executable file
23
site/content/en/docs/_index.md
Executable file
@@ -0,0 +1,23 @@
|
||||
|
||||
---
|
||||
title: "Documentation"
|
||||
linkTitle: "Documentation"
|
||||
menu:
|
||||
main:
|
||||
weight: 10
|
||||
---
|
||||
|
||||
{{% pageinfo %}}
|
||||
This is a placeholder page that shows you how to use this template site.
|
||||
{{% /pageinfo %}}
|
||||
|
||||
|
||||
This section is where the user documentation for your project lives - all the information your users need to understand and successfully use your project.
|
||||
|
||||
For large documentation sets we recommend adding content under the headings in this section, though if some or all of them don’t apply to your project feel free to remove them or add your own. You can see an example of a smaller Docsy documentation site in the [Docsy User Guide](https://docsy.dev/docs/), which lives in the [Docsy theme repo](https://github.com/google/docsy/tree/master/userguide) if you'd like to copy its docs section.
|
||||
|
||||
Other content such as marketing material, case studies, and community updates should live in the [About](/about/) and [Community](/community/) pages.
|
||||
|
||||
Find out how to use the Docsy theme in the [Docsy User Guide](https://docsy.dev/docs/). You can learn more about how to organize your documentation (and how we organized this site) in [Organizing Your Content](https://docsy.dev/docs/best-practices/organizing-content/).
|
||||
|
||||
|
||||
6
site/content/en/search.md
Normal file
6
site/content/en/search.md
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
title: Search Results
|
||||
layout: search
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user