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
+13-16
Original file line number
Diff line number
Diff line change
@@ -4,6 +4,13 @@ Welcome! We are very pleased you want to contribute to the documentation and/or
4
4
5
5
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.
6
6
7
+
For more information about contributing to the Kubernetes documentation, see:
8
+
9
+
*[Creating a Documentation Pull Request](http://kubernetes.io/docs/contribute/create-pull-request/)
10
+
*[Writing a New Topic](http://kubernetes.io/docs/contribute/write-new-topic/)
11
+
*[Staging Your Documentation Changes](http://kubernetes.io/docs/contribute/stage-documentation-changes/)
When you create a pull request (either against master or the upcoming release), your changes are staged in a custom subdomain on Netlify so that you can see your changes in rendered form before the PR is merged. You can use this to verify that everything is correct before the PR gets merged. To view your changes:
@@ -13,17 +20,17 @@ When you create a pull request (either against master or the upcoming release),
13
20
- Look for "deploy/netlify"; you'll see "Deploy Preview Ready!" if staging was successful
14
21
- Click "Details" to bring up the staged site and navigate to your changes
15
22
16
-
## Release Branch Staging
23
+
## Branch structure and staging
17
24
18
-
The Kubernetes site maintains staged versions at a subdomain provided by Netlify. Every PR for the Kubernetes site, either against the master branch or the upcoming release branch, is staged automatically.
25
+
The current version of the website is served out of the `master` branch. To make changes to the live docs, such as bug fixes, broken links, typos, etc, **target your pull request to the master branch**
19
26
20
-
The staging site for the next upcoming Kubernetes release is here: [http://kubernetes-io-vnext-staging.netlify.com/](http://kubernetes-io-vnext-staging.netlify.com/)
27
+
The `release-1.x` branch stores changes for **upcoming releases of Kubernetes**. For example, the `release-1.5` branch has changes for the 1.5 release. These changes target branches (and *not* master) to avoid publishing documentation updates prior to the release for which they're relevant. If you have a change for an upcoming release of Kubernetes, **target your pull request to the appropriate release branch**.
21
28
22
-
The staging site reflects the current state of what's been merged in the release branch, or in other words, what the docs will look like for the next upcoming release. It's automatically updated as new PRs get merged.
29
+
The staging site for the next upcoming Kubernetes release is here: [http://kubernetes-io-vnext-staging.netlify.com/](http://kubernetes-io-vnext-staging.netlify.com/). The staging site reflects the current state of what's been merged in the release branch, or in other words, what the docs will look like for the next upcoming release. It's automatically updated as new PRs get merged.
23
30
24
31
## Staging the site locally (using Docker)
25
32
26
-
Don't like installing stuff? Download and run a local staging server with a single `docker run` command.
33
+
Don't like installing stuff? Download and run a local staging server with a single `docker run` command.
@@ -47,7 +54,7 @@ Install Ruby 2.2 or higher. If you're on Linux, run these commands:
47
54
apt-get install ruby2.2
48
55
apt-get install ruby2.2-dev
49
56
50
-
* If you're on a Mac, follow [these instructions](https://gorails.com/setup/osx/).
57
+
* If you're on a Mac, follow [these instructions](https://gorails.com/setup/osx/).
51
58
* If you're on a Windows machine you can use the [Ruby Installer](http://rubyinstaller.org/downloads/). During the installation make sure to check the option for *Add Ruby executables to your PATH*.
52
59
53
60
The remainder of the steps should work the same across operating systems.
@@ -140,16 +147,6 @@ That, of course, will send users to:
140
147
141
148
(Or whatever Kubernetes release that docs branch is associated with.)
142
149
143
-
## Branch structure
144
-
145
-
The current version of the website is served out of the `master` branch. To make changes to the live docs, such as bug fixes, broken links, typos, etc, **target your pull request to the master branch**.
146
-
147
-
The `release-1.x` branches store changes for **upcoming releases of Kubernetes**. For example, the `release-1.5` branch has changes for the upcoming 1.5 release. These changes target branches (and *not* master) to avoid publishing documentation updates prior to the release for which they're relevant. If you have a change for an upcoming release of Kubernetes, **target your pull request to the appropriate release branch**.
148
-
149
-
Changes in the "docsv2" branch (where we are testing a revamp of the docs) are automatically staged here:
150
-
http://k8sdocs.github.io/docs/tutorials/
151
-
152
-
153
150
## Config yaml guidelines
154
151
155
152
Guidelines for config yamls that are included in the site docs. These
blurb: 'Tectonic is the enterprise-ready Kubernetes product, by CoreOS. It adds key features to allow you to manage, update, and control clusters in production.'
9
+
},
10
+
{
11
+
type: 0,
12
+
name: 'Deis',
13
+
logo: 'deis',
14
+
link: 'https://deis.com',
15
+
blurb: 'Deis the creators of Helm, Workflow, and Steward, helps developers and operators build, deploy, manage and scale their applications on top of Kubernetes.'
blurb: 'The Puppet module for Kubernetes makes it easy to manage Pods, Replication Controllers, Services and more in Kubernetes, and to build domain-specific interfaces to one\'s Kubernetes configuration.'
blurb: 'Wercker automates your build, test and deploy pipelines for launching containers and triggering rolling updates on your Kubernetes cluster. '
44
+
},
45
+
{
46
+
type: 0,
47
+
name: 'Rancher',
48
+
logo: 'rancher',
49
+
link: 'http://rancher.com/kubernetes/',
50
+
blurb: 'Rancher is an open-source, production-ready container management platform that makes it easy to deploy and leverage Kubernetes in the enterprise.'
51
+
},
52
+
{
53
+
type: 0,
54
+
name: 'Red Hat',
55
+
logo: 'redhat',
56
+
link: 'https://www.openshift.com/',
57
+
blurb: 'Leverage an enterprise Kubernetes platform to orchestrate complex, multi-container apps.'
blurb: 'AppFormix is a cloud infrastructure performance optimization service helping enterprise operators streamline their cloud operations on any Kubernetes cloud. '
blurb: 'The Canonical Distribution of Kubernetes enables you to operate Kubernetes clusters on demand on any major public cloud and private infrastructure.'
114
+
},
115
+
{
116
+
type: 0,
117
+
name: 'Distelli',
118
+
logo: 'distelli',
119
+
link: 'https://www.distelli.com/',
120
+
blurb: 'Pipelines from your source repositories to your Kubernetes Clusters on any cloud.'
blurb: 'The Nuage SDN platform provides policy-based networking between Kubernetes Pods and non-Kubernetes environments with visibility and security monitoring.'
128
+
},
129
+
{
130
+
type: 1,
131
+
name: 'Apprenda',
132
+
logo: 'apprenda',
133
+
link: 'https://apprenda.com/kubernetes-support/',
134
+
blurb: 'Apprenda offers flexible and wide range of support plans for pure play Kubernetes on your choice of infrastructure, cloud provider and operating system.'
135
+
},
136
+
{
137
+
type: 1,
138
+
name: 'Reactive Ops',
139
+
logo: 'reactive_ops',
140
+
link: 'https://www.reactiveops.com/kubernetes/',
141
+
blurb: 'ReactiveOps has written automation on best practices for infrastructure as code on GCP & AWS using Kubernetes, helping you build and maintain a world-class infrastructure at a fraction of the price of an internal hire.'
blurb: 'Samsung SDS’s Cloud Native Computing Team offers expert consulting across the range of technical aspects involved in building services targeted at a Kubernetes cluster.'
blurb: 'Container Solutions is a premium software consultancy that focuses on programmable infrastructure, offering our expertise in software development, strategy and operations to help you innovate at speed and scale.'
0 commit comments