Skip to content

Commit 46fc61c

Browse files
authored
Merge branch 'main' into patch-9
2 parents f8dcb7e + 1ec4e8e commit 46fc61c

File tree

21 files changed

+381
-76
lines changed

21 files changed

+381
-76
lines changed

config.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,7 @@ id = "UA-00000000-0"
123123
[params]
124124
copyright_k8s = "The Kubernetes Authors"
125125
copyright_linux = "Copyright © 2020 The Linux Foundation ®."
126+
126127
# privacy_policy = "https://policies.google.com/privacy"
127128

128129
# First one is picked as the Twitter card image if not set on page.

content/en/docs/concepts/cluster-administration/networking.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -260,12 +260,6 @@ Multus supports all [reference plugins](https://github.com/containernetworking/p
260260

261261
[NSX-T Container Plug-in (NCP)](https://docs.vmware.com/en/VMware-NSX-T/2.0/nsxt_20_ncp_kubernetes.pdf) provides integration between NSX-T and container orchestrators such as Kubernetes, as well as integration between NSX-T and container-based CaaS/PaaS platforms such as Pivotal Container Service (PKS) and OpenShift.
262262

263-
### Nuage Networks VCS (Virtualized Cloud Services)
264-
265-
[Nuage](https://www.nuagenetworks.net) provides a highly scalable policy-based Software-Defined Networking (SDN) platform. Nuage uses the open source Open vSwitch for the data plane along with a feature rich SDN Controller built on open standards.
266-
267-
The Nuage platform uses overlays to provide seamless policy-based networking between Kubernetes Pods and non-Kubernetes environments (VMs and bare metal servers). Nuage's policy abstraction model is designed with applications in mind and makes it easy to declare fine-grained policies for applications.The platform's real-time analytics engine enables visibility and security monitoring for Kubernetes applications.
268-
269263
### OVN (Open Virtual Networking)
270264

271265
OVN is an opensource network virtualization solution developed by the

content/en/docs/concepts/overview/working-with-objects/namespaces.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,7 @@ weight: 30
1010

1111
<!-- overview -->
1212

13-
Kubernetes supports multiple virtual clusters backed by the same physical cluster.
14-
These virtual clusters are called namespaces.
13+
In Kubernetes, _namespaces_ provides a mechanism for isolating groups of resources within a single cluster. Names of resources need to be unique within a namespace, but not across namespaces. Namespace-based scoping is applicable only for namespaced objects _(e.g. Deployments, Services, etc)_ and not for cluster-wide objects _(e.g. StorageClass, Nodes, PersistentVolumes, etc)_.
1514

1615
<!-- body -->
1716

content/en/docs/concepts/workloads/pods/_index.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,21 @@ with shared namespaces and shared filesystem volumes.
4848

4949
## Using Pods
5050

51+
The following is an example of a Pod which consists of a container running the image `nginx:1.14.2`.
52+
53+
{{< codenew file="pods/simple-pod.yaml" >}}
54+
55+
To create the Pod shown above, run the following command:
56+
```shell
57+
kubectl apply -f https://k8s.io/examples/pods/simple-pod.yaml
58+
```
59+
60+
Pods are generally not created directly and are created using workload resources.
61+
See [Working with Pods](#working-with-pods) for more information on how Pods are used
62+
with workload resources.
63+
64+
### Workload resources for managing pods
65+
5166
Usually you don't need to create Pods directly, even singleton Pods. Instead, create them using workload resources such as {{< glossary_tooltip text="Deployment"
5267
term_id="deployment" >}} or {{< glossary_tooltip text="Job" term_id="job" >}}.
5368
If your Pods need to track state, consider the

content/en/docs/contribute/_index.md

Lines changed: 87 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ Kubernetes documentation contributors:
2929
- Translate the documentation
3030
- Manage and publish the documentation parts of the Kubernetes release cycle
3131

32+
33+
3234
<!-- body -->
3335

3436
## Getting started
@@ -44,18 +46,98 @@ to work effectively in the Kubernetes community.
4446
To get involved with documentation:
4547

4648
1. Sign the CNCF [Contributor License Agreement](https://github.com/kubernetes/community/blob/master/CLA.md).
47-
1. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website)
49+
2. Familiarize yourself with the [documentation repository](https://github.com/kubernetes/website)
4850
and the website's [static site generator](https://gohugo.io).
49-
1. Make sure you understand the basic processes for
51+
3. Make sure you understand the basic processes for
5052
[opening a pull request](/docs/contribute/new-content/open-a-pr/) and
5153
[reviewing changes](/docs/contribute/review/reviewing-prs/).
5254

55+
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
56+
<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it -->
57+
58+
{{< mermaid >}}
59+
flowchart TB
60+
subgraph third[Open PR]
61+
direction TB
62+
U[ ] -.-
63+
Q[Improve content] --- N[Create content]
64+
N --- O[Translate docs]
65+
O --- P[Manage/publish docs parts<br>of K8s release cycle]
66+
67+
end
68+
69+
subgraph second[Review]
70+
direction TB
71+
T[ ] -.-
72+
D[Look over the<br>K8s/website<br>repository] --- E[Check out the<br>Hugo static site<br>generator]
73+
E --- F[Understand basic<br>GitHub commands]
74+
F --- G[Review open PR<br>and change review <br>processes]
75+
end
76+
77+
subgraph first[Sign up]
78+
direction TB
79+
S[ ] -.-
80+
B[Sign the CNCF<br>Contributor<br>License Agreement] --- C[Join sig-docs<br>Slack channel]
81+
C --- V[Join kubernetes-sig-docs<br>mailing list]
82+
V --- M[Attend weekly<br>sig-docs calls<br>or slack meetings]
83+
end
84+
85+
A([fa:fa-user New<br>Contributor]) --> first
86+
A --> second
87+
A --> third
88+
A --> H[Ask Questions!!!]
89+
90+
91+
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
92+
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
93+
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
94+
class A,B,C,D,E,F,G,H,M,Q,N,O,P,V grey
95+
class S,T,U spacewhite
96+
class first,second,third white
97+
{{</ mermaid >}}
98+
***Figure - Getting started for a new contributor***
99+
100+
The figure above outlines a roadmap for new contributors. You can follow some or all of the steps for `Sign up` and `Review`. Now you are ready to open PRs that achieve your contribution objectives with some listed under `Open PR`. Again, questions are always welcome!
101+
53102
Some tasks require more trust and more access in the Kubernetes organization.
54103
See [Participating in SIG Docs](/docs/contribute/participate/) for more details about
55104
roles and permissions.
56105

57106
## Your first contribution
58107

108+
You can prepare for your first contribution by reviewing several steps beforehand. The figure below outlines the steps and the details follow.
109+
110+
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
111+
<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it -->
112+
113+
{{< mermaid >}}
114+
flowchart LR
115+
subgraph second[First Contribution]
116+
direction TB
117+
S[ ] -.-
118+
G[Review PRs from other<br>K8s members] -->
119+
A[Check K8s/website<br>issues list for<br>good first PRs] --> B[Open a PR!!]
120+
end
121+
subgraph first[Suggested Prep]
122+
direction TB
123+
T[ ] -.-
124+
D[Read contribution overview] -->E[Read K8s content<br>and style guides]
125+
E --> F[Learn about Hugo page<br>content types<br>and shortcodes]
126+
end
127+
128+
129+
first ----> second
130+
131+
132+
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
133+
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
134+
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
135+
class A,B,D,E,F,G grey
136+
class S,T spacewhite
137+
class first,second white
138+
{{</ mermaid >}}
139+
***Figure - Preparation for your first contribution***
140+
59141
- Read the [Contribution overview](/docs/contribute/new-content/overview/) to
60142
learn about the different ways you can contribute.
61143
- Check [`kubernetes/website` issues list](https://github.com/kubernetes/website/issues/)
@@ -92,10 +174,12 @@ SIG Docs communicates with different methods:
92174
introduce yourself!
93175
- [Join the `kubernetes-sig-docs` mailing list](https://groups.google.com/forum/#!forum/kubernetes-sig-docs),
94176
where broader discussions take place and official decisions are recorded.
95-
- Join the [weekly SIG Docs video meeting](https://github.com/kubernetes/community/tree/master/sig-docs). Meetings are always announced on `#sig-docs` and added to the [Kubernetes community meetings calendar](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles). You'll need to download the [Zoom client](https://zoom.us/download) or dial in using a phone.
177+
- Join the [SIG Docs video meeting](https://github.com/kubernetes/community/tree/master/sig-docs) held every two weeks. Meetings are always announced on `#sig-docs` and added to the [Kubernetes community meetings calendar](https://calendar.google.com/calendar/embed?src=cgnt364vd8s86hr2phapfjc6uk%40group.calendar.google.com&ctz=America/Los_Angeles). You'll need to download the [Zoom client](https://zoom.us/download) or dial in using a phone.
178+
- Join the SIG Docs async Slack standup meeting on those weeks when the in-person Zoom video meeting does not take place. Meetings are always announced on `#sig-docs`. You can contribute to any one of the threads up to 24 hours after meeting announcement.
96179

97180
## Other ways to contribute
98181

99182
- Visit the [Kubernetes community site](/community/). Participate on Twitter or Stack Overflow, learn about local Kubernetes meetups and events, and more.
100183
- Read the [contributor cheatsheet](https://github.com/kubernetes/community/tree/master/contributors/guide/contributor-cheatsheet) to get involved with Kubernetes feature development.
101184
- Submit a [blog post or case study](/docs/contribute/new-content/blogs-case-studies/).
185+

content/en/docs/contribute/new-content/_index.md

Lines changed: 74 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -5,60 +5,114 @@ main_menu: true
55
weight: 20
66
---
77

8-
<!-- overview -->
98

10-
This section contains information you should know before contributing new content.
119

10+
<!-- overview -->
11+
12+
This section contains information you should know before contributing new
13+
content.
14+
<!-- See https://github.com/kubernetes/website/issues/28808 for live-editor URL to this figure -->
15+
<!-- You can also cut/paste the mermaid code into the live editor at https://mermaid-js.github.io/mermaid-live-editor to play around with it -->
16+
17+
{{< mermaid >}}
18+
flowchart LR
19+
subgraph second[Before you begin]
20+
direction TB
21+
S[ ] -.-
22+
A[Sign the CNCF CLA] --> B[Choose Git branch]
23+
B --> C[One language per PR]
24+
C --> F[Check out<br>contributor tools]
25+
end
26+
subgraph first[Contributing Basics]
27+
direction TB
28+
T[ ] -.-
29+
D[Write docs in markdown<br>and build site with Hugo] --- E[source in GitHub]
30+
E --- G[_'/content/../docs'_ folder contains docs<br>for multiple languages]
31+
G --- H[Review Hugo page content<br>types and shortcodes]
32+
end
33+
34+
35+
first ----> second
36+
37+
38+
classDef grey fill:#dddddd,stroke:#ffffff,stroke-width:px,color:#000000, font-size:15px;
39+
classDef white fill:#ffffff,stroke:#000,stroke-width:px,color:#000,font-weight:bold
40+
classDef spacewhite fill:#ffffff,stroke:#fff,stroke-width:0px,color:#000
41+
class A,B,C,D,E,F,G,H grey
42+
class S,T spacewhite
43+
class first,second white
44+
{{</ mermaid >}}
45+
46+
***Figure - Contributing new content preparation***
47+
48+
The figure above depicts the information you should know
49+
prior to submitting new content. The information details follow.
1250

1351

1452

1553
<!-- body -->
1654

1755
## Contributing basics
1856

19-
- Write Kubernetes documentation in Markdown and build the Kubernetes site using [Hugo](https://gohugo.io/).
20-
- The source is in [GitHub](https://github.com/kubernetes/website). You can find Kubernetes documentation at `/content/en/docs/`. Some of the reference documentation is automatically generated from scripts in the `update-imported-docs/` directory.
21-
- [Page content types](/docs/contribute/style/page-content-types/) describe the presentation of documentation content in Hugo.
57+
- Write Kubernetes documentation in Markdown and build the Kubernetes site
58+
using [Hugo](https://gohugo.io/).
59+
- The source is in [GitHub](https://github.com/kubernetes/website). You can find
60+
Kubernetes documentation at `/content/en/docs/`. Some of the reference
61+
documentation is automatically generated from scripts in
62+
the `update-imported-docs/` directory.
63+
- [Page content types](/docs/contribute/style/page-content-types/) describe the
64+
presentation of documentation content in Hugo.
2265
- In addition to the standard Hugo shortcodes, we use a number of
23-
[custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our documentation to control the presentation of content.
66+
[custom Hugo shortcodes](/docs/contribute/style/hugo-shortcodes/) in our
67+
documentation to control the presentation of content.
2468
- Documentation source is available in multiple languages in `/content/`. Each
2569
language has its own folder with a two-letter code determined by the
26-
[ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php). For
27-
example, English documentation source is stored in `/content/en/docs/`.
28-
- For more information about contributing to documentation in multiple languages or starting a new translation, see [localization](/docs/contribute/localization).
70+
[ISO 639-1 standard](https://www.loc.gov/standards/iso639-2/php/code_list.php)
71+
. For example, English documentation source is stored in `/content/en/docs/`.
72+
- For more information about contributing to documentation in multiple languages
73+
or starting a new translation,
74+
see [localization](/docs/contribute/localization).
2975

3076
## Before you begin {#before-you-begin}
3177

3278
### Sign the CNCF CLA {#sign-the-cla}
3379

34-
All Kubernetes contributors **must** read the [Contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md) and [sign the Contributor License Agreement (CLA)](https://github.com/kubernetes/community/blob/master/CLA.md).
80+
All Kubernetes contributors **must** read
81+
the [Contributor guide](https://github.com/kubernetes/community/blob/master/contributors/guide/README.md)
82+
and [sign the Contributor License Agreement (CLA)](https://github.com/kubernetes/community/blob/master/CLA.md)
83+
.
3584

36-
Pull requests from contributors who haven't signed the CLA fail the automated tests. The name and email you provide must match those found in your `git config`, and your git name and email must match those used for the CNCF CLA.
85+
Pull requests from contributors who haven't signed the CLA fail the automated
86+
tests. The name and email you provide must match those found in
87+
your `git config`, and your git name and email must match those used for the
88+
CNCF CLA.
3789

3890
### Choose which Git branch to use
3991

40-
When opening a pull request, you need to know in advance which branch to base your work on.
92+
When opening a pull request, you need to know in advance which branch to base
93+
your work on.
4194

4295
Scenario | Branch
4396
:---------|:------------
4497
Existing or new English language content for the current release | `main`
4598
Content for a feature change release | The branch which corresponds to the major and minor version the feature change is in, using the pattern `dev-<version>`. For example, if a feature changes in the `v{{< skew nextMinorVersion >}}` release, then add documentation changes to the ``dev-{{< skew nextMinorVersion >}}`` branch.
4699
Content in other languages (localizations) | Use the localization's convention. See the [Localization branching strategy](/docs/contribute/localization/#branching-strategy) for more information.
47100

48-
49101
If you're still not sure which branch to choose, ask in `#sig-docs` on Slack.
50102

51-
{{< note >}}
52-
If you already submitted your pull request and you know that the base branch
53-
was wrong, you (and only you, the submitter) can change it.
54-
{{< /note >}}
103+
{{< note >}} If you already submitted your pull request and you know that the
104+
base branch was wrong, you (and only you, the submitter) can change it. {{<
105+
/note >}}
55106

56107
### Languages per PR
57108

58-
Limit pull requests to one language per PR. If you need to make an identical change to the same code sample in multiple languages, open a separate PR for each language.
109+
Limit pull requests to one language per PR. If you need to make an identical
110+
change to the same code sample in multiple languages, open a separate PR for
111+
each language.
59112

60113
## Tools for contributors
61114

62-
The [doc contributors tools](https://github.com/kubernetes/website/tree/main/content/en/docs/doc-contributor-tools) directory in the `kubernetes/website` repository contains tools to help your contribution journey go more smoothly.
63-
115+
The [doc contributors tools](https://github.com/kubernetes/website/tree/main/content/en/docs/doc-contributor-tools)
116+
directory in the `kubernetes/website` repository contains tools to help your
117+
contribution journey go more smoothly.
64118

0 commit comments

Comments
 (0)