From 8e32206afba34d437836e21d1065dd417f556fa0 Mon Sep 17 00:00:00 2001 From: johndmulhausen Date: Thu, 11 Feb 2016 02:36:45 -0800 Subject: [PATCH] Update editdocs.md --- v1.1/editdocs.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/v1.1/editdocs.md b/v1.1/editdocs.md index c72e297392..82f96a435c 100644 --- a/v1.1/editdocs.md +++ b/v1.1/editdocs.md @@ -1,5 +1,5 @@ --- -title: Editing the Kubernetes Documentation +title: Contributing to Kubernetes Documentation section: support showedit: false --- @@ -11,7 +11,7 @@ $(document).ready(function(){ var page = window.location.hash.substring(1,window.location.hash.length); $("#editlink").html('

Continue with your edit

Click the below link to edit the page you were just on. When you are done, press "Commit Changes" at the bottom of the screen. This will create a copy of our site on your GitHub account called a "fork." You can make other changes in your fork after it is created, if you want. When you are ready to send us all your changes, go to the index page for your fork and click "New Pull Request" to let us know about it.

Edit "' + page + '"'); } else { - $("#editlink").html('

Getting Started

Click the below button to visit the repo for our site. You can then 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.

Visit our GitHub repo'); + $("#editlink").html('

Editing the site in the cloud

Click the below button to visit the repo for our site. You can then 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.

Visit our GitHub repo'); } }); @@ -20,6 +20,8 @@ Welcome! We are very pleased you want to contribute to the docs for Kubernetes. {% raw %}{% endraw %} +## Staging your changes in the cloud + If you want to see your changes staged without having to install anything locally, change your fork of our repo to be named: @@ -29,7 +31,7 @@ Then, visit: [http://YOUR_GITHUB_USERNAME.github.io](http://YOUR_GITHUB_USERNAME You should see a special-to-you version of the site. -## Running the site locally +## Editing and staging the site locally If you have files to upload, or just want to work offline, run the below commands to setup your environment for running GitHub pages locally. Then, any edits you make will be viewable @@ -79,4 +81,4 @@ might help for Windows users. ## Thank you! Kubernetes thrives on community participation and we really appreciate your -contributions to our site and our documentation! \ No newline at end of file +contributions to our site and our documentation!