Skip to content

Commit a0e672e

Browse files
Updated README.md with information on Netlify staging and removed outdated information on versioned doc branches.
1 parent fd53418 commit a0e672e

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

README.md

+14-16
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,22 @@ Welcome! We are very pleased you want to contribute to the documentation and/or
44

55
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.
66

7-
## Staging the site on GitHub Pages
7+
## Automatic Staging for Pull Requests
88

9-
If you want to see your changes staged without having to install anything locally, remove the CNAME file in this directory and
10-
change the name of the fork to be:
9+
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:
1110

12-
YOUR_GITHUB_USERNAME.github.io
11+
- Scroll down to the PR's list of Automated Checks
12+
- Click "Show All Checks"
13+
- Look for "deploy/netlify"; you'll see "Deploy Preview Ready!" if staging was successful
14+
- Click "Details" to bring up the staged site and navigate to your changes
1315

14-
Then make your changes.
16+
## Release Branch Staging
1517

16-
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.
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.
19+
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/)
21+
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.
1723

1824
## Staging the site locally (using Docker)
1925

@@ -64,7 +70,6 @@ Make any changes you want. Then, to see your changes locally:
6470
Your copy of the site will then be viewable at: [http://localhost:4000](http://localhost:4000)
6571
(or wherever Jekyll tells you).
6672

67-
6873
## GitHub help
6974

7075
If you're a bit rusty with git/GitHub, you might want to read
@@ -137,20 +142,13 @@ That, of course, will send users to:
137142

138143
## Branch structure
139144

140-
The current version of the website is served out of the `master` branch.
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**.
141146

142-
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).
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**.
143148

144149
Changes in the "docsv2" branch (where we are testing a revamp of the docs) are automatically staged here:
145150
http://k8sdocs.github.io/docs/tutorials/
146151

147-
Changes in the "release-1.1" branch (for k8s v1.1 docs) are automatically staged here:
148-
http://kubernetes-v1-1.github.io/
149-
150-
Changes in the "release-1.3" branch (for k8s v1.3 docs) are automatically staged here:
151-
http://kubernetes-v1-3.github.io/
152-
153-
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).
154152

155153
## Config yaml guidelines
156154

0 commit comments

Comments
 (0)