You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+45-30Lines changed: 45 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,44 +6,48 @@ Welcome! We are very pleased you want to contribute to the documentation and/or
6
6
7
7
You can click the "Fork" button in the upper-right area of the screen to create a copy of our site on your GitHub account called a "fork." Make any changes you want in your fork, and when you are ready to send those changes to us, go to the index page for your fork and click "New Pull Request" to let us know about it.
8
8
9
+
## Staging the site on GitHub Pages
10
+
9
11
If you want to see your changes staged without having to install anything locally, remove the CNAME file in this directory and
You should see a special-to-you version of the site.
18
+
When you visit [http://YOUR_GITHUB_USERNAME.github.io](http://YOUR_GITHUB_USERNAME.github.io) you should see a special-to-you version of the site that contains the changes you just made.
17
19
18
-
## Editing/staging the site locally
20
+
## Staging the site locally (using Docker)
19
21
20
-
If you have files to upload, or just want to work offline, run the below commands to setup
21
-
your environment for running GitHub pages locally. Then, any edits you make will be viewable
22
-
on a lightweight webserver that runs on your local machine.
22
+
Don't like installing stuff? Download and run a local staging server with a single `docker run` command.
docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 johndmulhausen/k8sdocs
23
27
24
-
First install rvm
28
+
Then visit [http://localhost:4000](http://localhost:4000) to see our site. Any changes you make on your local machine will be automatically staged.
25
29
26
-
curl -sSL https://get.rvm.io | bash -s stable
30
+
If you're interested you can view [the Dockerfile for this image](https://gist.github.com/johndmulhausen/f8f0ab8d82d2c755af3a4709729e1859).
27
31
28
-
Then load it into your environment
32
+
## Staging the site locally (from scratch setup)
29
33
30
-
source ${HOME}/.rvm/scripts/rvm (or whatever is prompted by the installer)
34
+
The below commands to setup your environment for running GitHub pages locally. Then, any edits you make will be viewable
35
+
on a lightweight webserver that runs on your local machine.
36
+
37
+
This will typically be the fastest way (by far) to iterate on docs changes and see them staged, once you get this set up, but it does involve several install steps that take awhile to complete, and makes system-wide modifications.
31
38
32
-
Then install Ruby 2.2 or higher
39
+
Install Ruby 2.2 or higher. If you're on a Mac, follow [these instructions](https://gorails.com/setup/osx/). If you're on Linux, run these commands:
33
40
34
-
rvm install ruby-2.2.4
35
-
rvm use ruby-2.2.4 --default
36
-
37
-
Verify that this new version is running (optional)
41
+
apt-get install software-properties-common
42
+
apt-add-repository ppa:brightbox/ruby-ng
43
+
apt-get install ruby2.2
44
+
apt-get install ruby2.2-dev
38
45
39
-
which ruby
40
-
ruby -v
41
-
42
-
Install the GitHub Pages package, which includes Jekyll
46
+
Install the GitHub Pages package, which includes Jekyll:
### Edit Page Titles or Change the Left Navigation
68
73
69
-
Edit the yaml files in `/_data/` for the Guides, Reference, Samples, or Support areas.
74
+
Edit the yaml files in `/_data/` for the Guides, Reference, Samples, or Support areas.
70
75
71
76
You may have to exit and `jekyll clean` before restarting the `jekyll serve` to
72
77
get changes to files in `/_data/` to show up.
@@ -107,11 +112,11 @@ In English, this would read: "Create a set of tabs with the alias `servicesample
107
112
and have tabs visually labeled "JSON" and "YAML" that use `json` and `yaml` Rouge syntax highlighting, which display the contents of
108
113
`service-sample.{extension}` on the page, and link to the file in GitHub at (full path)."
109
114
110
-
Example file: [Pods: Multi-Container](/docs/user-guide/pods/multi-container/).
115
+
Example file: [Pods: Multi-Container](http://kubernetes.io/docs/user-guide/pods/multi-container/).
111
116
112
117
## Use a global variable
113
118
114
-
The `/_config.yml` file defines some useful variables you can use when editing docs.
119
+
The `/_config.yml` file defines some useful variables you can use when editing docs.
115
120
116
121
*`page.githubbranch`: The name of the GitHub branch on the Kubernetes repo that is associated with this branch of the docs. e.g. `release-1.2`
117
122
*`page.version` The version of Kubernetes associated with this branch of the docs. e.g. `v1.2`
@@ -133,17 +138,27 @@ The current version of the website is served out of the `master` branch.
133
138
134
139
All versions of the site that relate to past and future versions will be named after their Kubernetes release number. For example, [the old branch for the 1.1 docs is called `release-1.1`](https://github.com/kubernetes/kubernetes.github.io/tree/release-1.1).
135
140
136
-
Changes in the "docsv2" branch (where we are testing a revamp of the docs) are automatically staged here:
141
+
Changes in the "docsv2" branch (where we are testing a revamp of the docs) are automatically staged here:
137
142
http://k8sdocs.github.io/docs/tutorials/
138
143
139
144
Changes in the "release-1.1" branch (for k8s v1.1 docs) are automatically staged here:
140
145
http://kubernetes-v1-1.github.io/
141
146
142
-
Changes in the "release-1.3" branch (for k8s v1.3 docs) are automatically staged here:
147
+
Changes in the "release-1.3" branch (for k8s v1.3 docs) are automatically staged here:
143
148
http://kubernetes-v1-3.github.io/
144
149
145
150
Editing of these branches will kick off a build using Travis CI that auto-updates these URLs; you can monitor the build progress at [https://travis-ci.org/kubernetes/kubernetes.github.io](https://travis-ci.org/kubernetes/kubernetes.github.io).
146
151
152
+
## Partners
153
+
Partners can get their logos added to the partner section of the [community page](http://k8s.io/community) by following the below steps and meeting the below logo specifications. Partners will also need to have a URL that is specific to integrating with Kubernetes ready; this URL will be the destination when the logo is clicked.
154
+
155
+
* The partner product logo should be a transparent png image centered in a 215x125 px frame. (look at the existing logos for reference)
156
+
* The logo must link to a URL that is specific to integrating with Kubernetes, hosted on the partner's site.
157
+
* The logo should be named *product-name*_logo.png and placed in the `/images/community_logos` folder.
158
+
* The image reference (including the link to the partner URL) should be added in `community.html` under `<div class="partner-logos" > ...</div>`.
159
+
* Please do not change the order of the existing partner images. Append your logo to the end of the list.
160
+
* Once completed and tested the look and feel, submit the pull request.
161
+
147
162
## Thank you!
148
163
149
164
Kubernetes thrives on community participation and we really appreciate your
Copy file name to clipboardExpand all lines: _includes/templates/concept-overview.md
+9-91Lines changed: 9 additions & 91 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,20 +10,8 @@
10
10
11
11
{% else %}
12
12
13
-
### ERROR: You must define a "what_is" block
14
-
{: style="color:red" }
15
-
16
-
This template requires that you explain what this concept is. This explanation will
17
-
be displayed under the heading, **What is a {{ concept }}?**
18
-
19
-
To get rid of this message and take advantage of this template, define the `what_is`
20
-
variable and populate it with content.
13
+
{% include templates/_errorthrower.md missing_block='what_is' heading='What is a (Concept)?' purpose='explains what this concept is and its purpose.' %}
21
14
22
-
```liquid
23
-
{% raw %}{% capture what_is %}{% endraw %}
24
-
A {{ concept }} does x and y and z...(etc, etc, text goes on)
25
-
{% raw %}{% endcapture %}{% endraw %}
26
-
```
27
15
{% endif %}
28
16
29
17
@@ -35,45 +23,21 @@ A {{ concept }} does x and y and z...(etc, etc, text goes on)
35
23
36
24
{% else %}
37
25
38
-
### ERROR: You must define a "when_to_use" block
39
-
{: style="color:red" }
40
-
41
-
This template requires that you explain when to use this object. This explanation will
42
-
be displayed under the heading, **When to use {{ concept }}s**
26
+
{% include templates/_errorthrower.md missing_block='when_to_use' heading='When to use (Concept)' purpose='explains when to use this object.' %}
43
27
44
-
To get rid of this message and take advantage of this template, define the `when_to_use`
45
-
variable and populate it with content.
46
-
47
-
```liquid
48
-
{% raw %}{% capture when_to_use %}{% endraw %}
49
-
You should use {{ concept }} when...
50
-
{% raw %}{% endcapture %}{% endraw %}
51
-
```
52
28
{% endif %}
53
29
54
30
55
31
{% if when_not_to_use %}
56
32
57
-
### When not to use {{ concept }}s (alternatives)
33
+
### When not to use {{ concept }}s
58
34
59
35
{{ when_not_to_use }}
60
36
61
37
{% else %}
62
38
63
-
### ERROR: You must define a "when_not_to_use" block
64
-
{: style="color:red" }
65
-
66
-
This template requires that you explain when not to use this object. This explanation will
67
-
be displayed under the heading, **When not to use {{ concept }}s (alternatives)**
68
-
69
-
To get rid of this message and take advantage of this template, define the `when_not_to_use`
70
-
block and populate it with content.
39
+
{% include templates/_errorthrower.md missing_block='when_not_to_use' heading='When not to use (Concept)' purpose='explains when not to use this object.' %}
71
40
72
-
```liquid
73
-
{% raw %}{% capture when_not_to_use %}{% endraw %}
74
-
You should not use {{ concept }} if...
75
-
{% raw %}{% endcapture %}{% endraw %}
76
-
```
77
41
{% endif %}
78
42
79
43
@@ -85,69 +49,23 @@ You should not use {{ concept }} if...
85
49
86
50
{% else %}
87
51
88
-
### ERROR: You must define a "status" block
89
-
{: style="color:red" }
90
-
91
-
This template requires that you explain the current status of support for this object.
92
-
This explanation will be displayed under the heading, **{{ concept }} status**.
52
+
{% include templates/_errorthrower.md missing_block='status' heading='Retrieving status for a (Concept)' purpose='explains how to retrieve a status description for this object.' %}
93
53
94
-
To get rid of this message and take advantage of this template, define the `status`
95
-
block and populate it with content.
96
-
97
-
```liquid
98
-
{% raw %}{% capture status %}{% endraw %}
99
-
The current status of {{ concept }}s is...
100
-
{% raw %}{% endcapture %}{% endraw %}
101
-
```
102
54
{% endif %}
103
55
104
56
105
-
{% if required_fields %}
57
+
{% if usage %}
106
58
107
-
###{{ concept }} spec
59
+
#### Usage
108
60
109
-
#### Required Fields
110
-
111
-
{{ required_fields }}
61
+
{{ usage }}
112
62
113
63
{% else %}
114
64
115
-
### ERROR: You must define a "required_fields" block
116
-
{: style="color:red" }
117
-
118
-
This template requires that you provide a Markdown list of required fields for this
119
-
object. This list will be displayed under the heading **Required Fields**.
120
-
121
-
To get rid of this message and take advantage of this template, define the `required_fields`
122
-
block and populate it with content.
123
-
124
-
```liquid
125
-
{% raw %}{% capture required_fields %}
126
-
* `kind`: Always `Pod`.
127
-
* `apiVersion`: Currently `v1`.
128
-
* `metadata`: An object containing:
129
-
* `name`: Required if `generateName` is not specified. The name of this pod.
130
-
It must be an
131
-
[RFC1035](https://www.ietf.org/rfc/rfc1035.txt) compatible value and be
132
-
unique within the namespace.
133
-
{% endcapture %}{% endraw %}
134
-
```
135
-
136
-
**Note**: You can also define a `common_fields` block that will go under a heading
137
-
directly underneath **Required Fields** called **Common Fields**, but it is
138
-
not required.
139
-
{% endif %}
140
-
141
-
142
-
{% if common_fields %}
143
-
144
-
#### Common Fields
145
-
146
-
{{ common_fields }}
65
+
{% include templates/_errorthrower.md missing_block='usage' heading='Usage' purpose='shows the most basic, common use case for this object, in the form of a code sample, command, etc, using tabs to show multiple approaches' %}
{% for seealso in site.data.kubectl[command].see_also %}
30
+
-[`{{ seealso }}`](/docs/kubectl/{% if seealso != "kubectl" %}kubectl_{{seealso}}{% endif %})
31
+
{% endfor %}
32
+
33
+
{% else %}
34
+
35
+
{% include templates/_errorthrower.md missing_block='command' heading='kubectl (command)' purpose='names the kubectl command, so that the appropriate YAML file (from _data/kubectl) can be transformed into a page.' %}
0 commit comments