Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix update documentation reference to doc location #1247

Merged
merged 1 commit into from
Sep 26, 2016
Merged

Fix update documentation reference to doc location #1247

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 4 additions & 11 deletions docs/user-guide/update-demo/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ here](https://github.com/kubernetes/kubernetes.github.io/tree/{{page.docsbranch}

### Step Zero: Prerequisites

This example assumes that you have forked the repository and [turned up a Kubernetes cluster](/docs/getting-started-guides/):
This example assumes that you have forked the docs repository and [turned up a Kubernetes cluster](/docs/getting-started-guides/):

```shell
$ cd kubernetes
$ ./cluster/kube-up.sh
$ git clone -b {{page.docsbranch}} https://github.com/kubernetes/kubernetes.github.io
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what this include is supposed to accomplish, but we're not hosting versioned docs or anything. We never actually were; GitHub pages doesn't let you host multiple branches. Everything was being cloned to a dummy organization.

You can probably go ahead and take it out.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@devin-donnelly the kubernetes repo no longer contains the user-guide docs. As a result cd kubernetes is no longer accurate as the rest of the update demo documentation assumes the user docs are under the docs directory. So this patch(include) is fixing the issue that that current assumptions are incorrect.

@devin-donnelly Now what do you specifically want taken out? Only the -b {{page.docsbranch}} part? Or the whole git clone statement?

Please be as specific as possible. I usually do not write docs and just happened to stumble upon an issue with the docs which I fixed in this patch..

$ cd kubernetes.github.io
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need the whole repo but just the files in https://github.com/kubernetes/kubernetes.github.io/tree/master/docs/user-guide/update-demo

cc @kubernetes/docs should we link to master or to a specific branch such as https://github.com/kubernetes/kubernetes.github.io/tree/release-1.4/docs/user-guide/update-demo

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree on linking to specific branch. Will fix that in next patch.

afaik there is no easy way to just copy the update-demo folder unless we upload it as an independent archive somewhere. Currently the demo requires you to run kubectl proxy on a whole directory so it's not as easy as just linking to 2 files.

For the kubectl create commands we can use kubectl create -f http://location-to-yaml-file.yaml but let's do that as separate patch.

Note though: This patch is only about fixing broken stuff not about improving the update-demo docs in general. I don't want it to get bloated. Currently update docs are broken because doc location moved from kubernetes repo to kubernetes.github.io repo and this should get fixed first.

```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we're not using ./cluster/kube-up.sh in this doc anymore we should remove ./cluster/kube-down.sh in L87 as well

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree. Will fix in next patch.


### Step One: Turn up the UX for the demo
Expand Down Expand Up @@ -81,14 +81,7 @@ This first stops the replication controller by turning the target number of repl

### Step Six: Cleanup

To turn down a Kubernetes cluster:

```shell
$ ./cluster/kube-down.sh
```

Kill the proxy running in the background:
After you are done running this demo make sure to kill it:
After you are done running this demo make sure to kill the proxy running in the background:

```shell
$ jobs
Expand Down