2016-11-04 18:32:50 +00:00
---
layout: docwithnav
2016-12-15 20:16:54 +00:00
title: Contributing to the Kubernetes Documentation
2016-11-04 18:32:50 +00:00
---
<!-- BEGIN: Gotta keep this section JS/HTML because it swaps out content dynamically -->
< p > < / p >
< script language = "JavaScript" >
var forwarding=window.location.hash.replace("#","");
$( document ).ready(function() {
if(forwarding) {
2017-03-23 07:10:00 +00:00
$("#generalInstructions").hide();
$("#continueEdit").show();
$("#continueEditButton").text("Edit " + forwarding);
2017-08-10 23:41:10 +00:00
$("#continueEditButton").attr("href", "https://github.com/kubernetes/kubernetes.github.io/edit/{{ page.docsbranch }}/" + forwarding)
2017-03-23 07:10:00 +00:00
$("#viewOnGithubButton").text("View " + forwarding + " on GitHub");
2017-06-26 22:40:13 +00:00
$("#viewOnGithubButton").attr("href", "https://git.k8s.io/kubernetes.github.io/" + forwarding)
2016-11-04 18:32:50 +00:00
} else {
$("#generalInstructions").show();
2017-03-23 07:10:00 +00:00
$("#continueEdit").hide();
2016-11-04 18:32:50 +00:00
}
});
< / script >
< div id = "continueEdit" >
< h2 > Continue your edit< / h2 >
2017-07-01 19:34:12 +00:00
< p > < b > To make changes to the document, do the following:< / b > < / p >
< ol >
< li > Click the button below to edit the page you were just on.< / li >
< li > Click < b > Commit Changes< / b > at the bottom of the screen to create a copy of our site in your GitHub account called a < i > fork< / i > .< / li >
< li > You can make other changes in your fork after it is created, if you want.< / li >
< li > On the index page, click < b > New Pull Request< / b > to let us know about it.< / li >
< / ol >
2016-11-04 18:32:50 +00:00
< p > < a id = "continueEditButton" class = "button" > < / a > < / p >
2017-03-20 19:49:47 +00:00
< p > < a id = "viewOnGithubButton" class = "button" > < / a > < / p >
2016-11-04 18:32:50 +00:00
< / div >
< div id = "generalInstructions" >
< h2 > Edit our site in the cloud< / h2 >
2016-11-24 06:14:09 +00:00
< p > Click the button below to visit the repo for our site. You can then click the < b > Fork< / b > button in the upper-right area of the screen to create a copy of our site in your GitHub account called a < i > fork< / i > . 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 < b > New Pull Request< / b > to let us know about it.< / p >
2016-11-04 18:32:50 +00:00
< p > < a class = "button" href = "https://github.com/kubernetes/kubernetes.github.io/" > Browse this site's source code< / a > < / p >
< / div >
<!-- END: Dynamic section -->
2016-11-24 06:14:09 +00:00
< br / >
2016-11-04 18:32:50 +00:00
2016-11-24 06:14:09 +00:00
For more information about contributing to the Kubernetes documentation, see:
2017-07-10 22:13:19 +00:00
* [Creating a Documentation Pull Request ](/docs/home/contribute/create-pull-request/ )
* [Writing a New Topic ](/docs/home/contribute/write-new-topic/ )
* [Staging Your Documentation Changes ](/docs/home/contribute/stage-documentation-changes/ )
* [Using Page Templates ](/docs/home/contribute/page-templates/ )
* [Documentation Style Guide ](/docs/home/contribute/style-guide/ )