Skip to content

Commit 1ec7fe8

Browse files
committed
Tweak line wrappings in content-organization.md
1 parent 903aca3 commit 1ec7fe8

File tree

3 files changed

+119
-67
lines changed

3 files changed

+119
-67
lines changed

content/en/docs/contribute/style/content-guide.md

+7-10
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,6 @@ You can register for Kubernetes Slack at https://slack.k8s.io/.
1717
For information on creating new content for the Kubernetes
1818
docs, follow the [style guide](/docs/contribute/style/style-guide).
1919

20-
21-
2220
<!-- body -->
2321

2422
## Overview
@@ -40,15 +38,19 @@ Kubernetes docs allow content for third-party projects only when:
4038

4139
### Third party content
4240

43-
Kubernetes documentation includes applied examples of projects in the Kubernetes project&mdash;projects that live in the [kubernetes](https://github.com/kubernetes) and
41+
Kubernetes documentation includes applied examples of projects in the Kubernetes
42+
project&mdash;projects that live in the [kubernetes](https://github.com/kubernetes) and
4443
[kubernetes-sigs](https://github.com/kubernetes-sigs) GitHub organizations.
4544

4645
Links to active content in the Kubernetes project are always allowed.
4746

4847
Kubernetes requires some third party content to function. Examples include container runtimes (containerd, CRI-O, Docker),
49-
[networking policy](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) (CNI plugins), [Ingress controllers](/docs/concepts/services-networking/ingress-controllers/), and [logging](/docs/concepts/cluster-administration/logging/).
48+
[networking policy](/docs/concepts/extend-kubernetes/compute-storage-net/network-plugins/) (CNI plugins),
49+
[Ingress controllers](/docs/concepts/services-networking/ingress-controllers/),
50+
and [logging](/docs/concepts/cluster-administration/logging/).
5051

51-
Docs can link to third-party open source software (OSS) outside the Kubernetes project only if it's necessary for Kubernetes to function.
52+
Docs can link to third-party open source software (OSS) outside the Kubernetes
53+
project only if it's necessary for Kubernetes to function.
5254

5355
### Dual sourced content
5456

@@ -59,19 +61,14 @@ Dual-sourced content requires double the effort (or more!) to maintain
5961
and grows stale more quickly.
6062

6163
{{< note >}}
62-
6364
If you're a maintainer for a Kubernetes project and need help hosting your own docs,
6465
ask for help in [#sig-docs on Kubernetes Slack](https://kubernetes.slack.com/messages/C1J0BPD2M/).
65-
6666
{{< /note >}}
6767

6868
### More information
6969

7070
If you have questions about allowed content, join the [Kubernetes Slack](https://slack.k8s.io/) #sig-docs channel and ask!
7171

72-
73-
7472
## {{% heading "whatsnext" %}}
7573

76-
7774
* Read the [Style guide](/docs/contribute/style/style-guide).

content/en/docs/contribute/style/content-organization.md

+39-31
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,10 @@ content_type: concept
44
weight: 90
55
---
66

7-
87
<!-- overview -->
98

109
This site uses Hugo. In Hugo, [content organization](https://gohugo.io/content-management/organization/) is a core concept.
1110

12-
13-
1411
<!-- body -->
1512

1613
{{% note %}}
@@ -21,7 +18,9 @@ This site uses Hugo. In Hugo, [content organization](https://gohugo.io/content-m
2118

2219
### Page Order
2320

24-
The documentation side menu, the documentation page browser etc. are listed using Hugo's default sort order, which sorts by weight (from 1), date (newest first), and finally by the link title.
21+
The documentation side menu, the documentation page browser etc. are listed using
22+
Hugo's default sort order, which sorts by weight (from 1), date (newest first),
23+
and finally by the link title.
2524

2625
Given that, if you want to move a page or a section up, set a weight in the page's front matter:
2726

@@ -30,34 +29,36 @@ title: My Page
3029
weight: 10
3130
```
3231
33-
3432
{{% note %}}
35-
For page weights, it can be smart not to use 1, 2, 3 ..., but some other interval, say 10, 20, 30... This allows you to insert pages where you want later.
36-
Additionally, each weight within the same directory (section) should not be overlapped with the other weights. This makes sure that content is always organized correctly, especially in localized content.
33+
For page weights, it can be smart not to use 1, 2, 3 ..., but some other interval,
34+
say 10, 20, 30... This allows you to insert pages where you want later.
35+
Additionally, each weight within the same directory (section) should not be
36+
overlapped with the other weights. This makes sure that content is always
37+
organized correctly, especially in localized content.
3738
{{% /note %}}
3839
39-
4040
### Documentation Main Menu
4141
42-
The `Documentation` main menu is built from the sections below `docs/` with the `main_menu` flag set in front matter of the `_index.md` section content file:
42+
The `Documentation` main menu is built from the sections below `docs/` with
43+
the `main_menu` flag set in front matter of the `_index.md` section content file:
4344

4445
```yaml
4546
main_menu: true
4647
```
4748

48-
49-
Note that the link title is fetched from the page's `linkTitle`, so if you want it to be something different than the title, change it in the content file:
50-
49+
Note that the link title is fetched from the page's `linkTitle`, so if you want
50+
it to be something different than the title, change it in the content file:
5151

5252
```yaml
5353
main_menu: true
5454
title: Page Title
5555
linkTitle: Title used in links
5656
```
5757

58-
5958
{{% note %}}
60-
The above needs to be done per language. If you don't see your section in the menu, it is probably because it is not identified as a section by Hugo. Create a `_index.md` content file in the section folder.
59+
The above needs to be done per language. If you don't see your section in the menu,
60+
it is probably because it is not identified as a section by Hugo. Create a
61+
`_index.md` content file in the section folder.
6162
{{% /note %}}
6263

6364
### Documentation Side Menu
@@ -72,11 +73,13 @@ If you don't want to list a section or page, set the `toc_hide` flag to `true` i
7273
toc_hide: true
7374
```
7475

75-
When you navigate to a section that has content, the specific section or page (e.g. `_index.md`) is shown. Else, the first page inside that section is shown.
76+
When you navigate to a section that has content, the specific section or page
77+
(e.g. `_index.md`) is shown. Else, the first page inside that section is shown.
7678

7779
### Documentation Browser
7880

79-
The page browser on the documentation home page is built using all the sections and pages that are directly below the `docs section`.
81+
The page browser on the documentation home page is built using all the sections
82+
and pages that are directly below the `docs section`.
8083

8184
If you don't want to list a section or page, set the `toc_hide` flag to `true` in front matter:
8285

@@ -86,14 +89,18 @@ toc_hide: true
8689

8790
### The Main Menu
8891

89-
The site links in the top-right menu -- and also in the footer -- are built by page-lookups. This is to make sure that the page actually exists. So, if the `case-studies` section does not exist in a site (language), it will not be linked to.
90-
92+
The site links in the top-right menu -- and also in the footer -- are built by
93+
page-lookups. This is to make sure that the page actually exists. So, if the
94+
`case-studies` section does not exist in a site (language), it will not be linked to.
9195

9296
## Page Bundles
9397

94-
In addition to standalone content pages (Markdown files), Hugo supports [Page Bundles](https://gohugo.io/content-management/page-bundles/).
98+
In addition to standalone content pages (Markdown files), Hugo supports
99+
[Page Bundles](https://gohugo.io/content-management/page-bundles/).
95100

96-
One example is [Custom Hugo Shortcodes](/docs/contribute/style/hugo-shortcodes/). It is considered a `leaf bundle`. Everything below the directory, including the `index.md`, will be part of the bundle. This also includes page-relative links, images that can be processed etc.:
101+
One example is [Custom Hugo Shortcodes](/docs/contribute/style/hugo-shortcodes/).
102+
It is considered a `leaf bundle`. Everything below the directory, including the `index.md`,
103+
will be part of the bundle. This also includes page-relative links, images that can be processed etc.:
97104

98105
```bash
99106
en/docs/home/contribute/includes
@@ -103,7 +110,8 @@ en/docs/home/contribute/includes
103110
└── podtemplate.json
104111
```
105112

106-
Another widely used example is the `includes` bundle. It sets `headless: true` in front matter, which means that it does not get its own URL. It is only used in other pages.
113+
Another widely used example is the `includes` bundle. It sets `headless: true` in
114+
front matter, which means that it does not get its own URL. It is only used in other pages.
107115

108116
```bash
109117
en/includes
@@ -118,22 +126,22 @@ en/includes
118126

119127
Some important notes to the files in the bundles:
120128

121-
* For translated bundles, any missing non-content files will be inherited from languages above. This avoids duplication.
122-
* All the files in a bundle are what Hugo calls `Resources` and you can provide metadata per language, such as parameters and title, even if it does not supports front matter (YAML files etc.). See [Page Resources Metadata](https://gohugo.io/content-management/page-resources/#page-resources-metadata).
123-
* The value you get from `.RelPermalink` of a `Resource` is page-relative. See [Permalinks](https://gohugo.io/content-management/urls/#permalinks).
124-
129+
* For translated bundles, any missing non-content files will be inherited from
130+
languages above. This avoids duplication.
131+
* All the files in a bundle are what Hugo calls `Resources` and you can provide
132+
metadata per language, such as parameters and title, even if it does not supports
133+
front matter (YAML files etc.).
134+
See [Page Resources Metadata](https://gohugo.io/content-management/page-resources/#page-resources-metadata).
135+
* The value you get from `.RelPermalink` of a `Resource` is page-relative.
136+
See [Permalinks](https://gohugo.io/content-management/urls/#permalinks).
125137

126138
## Styles
127139

128-
The [SASS](https://sass-lang.com/) source of the stylesheets for this site is stored in `assets/sass` and is automatically built by Hugo.
129-
130-
140+
The [SASS](https://sass-lang.com/) source of the stylesheets for this site is
141+
stored in `assets/sass` and is automatically built by Hugo.
131142

132143
## {{% heading "whatsnext" %}}
133144

134-
135145
* Learn about [custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/)
136146
* Learn about the [Style guide](/docs/contribute/style/style-guide)
137147
* Learn about the [Content guide](/docs/contribute/style/content-guide)
138-
139-

0 commit comments

Comments
 (0)