From 36fefcf87343ac66703561c6442e513611692a01 Mon Sep 17 00:00:00 2001 From: Pallav Agarwal Date: Mon, 5 Sep 2016 13:50:49 +0530 Subject: [PATCH 1/4] Correct broken links - fix #1154, fix #1161, fix #1162, fix #1163 Fix some broken links in documentation, as well as add a dummy page for single-node docker with deprecation notice to prevent error with old links. --- docs/admin/dns.md | 2 +- docs/getting-started-guides/docker.md | 3 +++ docs/user-guide/kubectl/kubectl_version.md | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) create mode 100644 docs/getting-started-guides/docker.md diff --git a/docs/admin/dns.md b/docs/admin/dns.md index bdd0848cf9..a85f2338ce 100644 --- a/docs/admin/dns.md +++ b/docs/admin/dns.md @@ -41,7 +41,7 @@ Kubernetes installations. This required some minor (backward-compatible) changes to the way the Kubernetes cluster DNS server processes DNS queries, to facilitate the lookup of federated services (which span multiple Kubernetes clusters). -See the [Cluster Federation Administrators' Guide](/docs/admin/federation/index.md) for more +See the [Cluster Federation Administrators' Guide](/docs/admin/federation) for more details on Cluster Federation and multi-site support. ## References diff --git a/docs/getting-started-guides/docker.md b/docs/getting-started-guides/docker.md new file mode 100644 index 0000000000..9044058834 --- /dev/null +++ b/docs/getting-started-guides/docker.md @@ -0,0 +1,3 @@ +# *Stop. This guide has been superseded by [Minikube](../minikube/). The link below is present only for historical purposes* + +The document has been moved to [here](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/local-cluster/docker.md) diff --git a/docs/user-guide/kubectl/kubectl_version.md b/docs/user-guide/kubectl/kubectl_version.md index 1392de872a..014d7f5e7b 100644 --- a/docs/user-guide/kubectl/kubectl_version.md +++ b/docs/user-guide/kubectl/kubectl_version.md @@ -50,7 +50,7 @@ kubectl version ### SEE ALSO -* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager +* [kubectl](../kubectl.md) - kubectl controls the Kubernetes cluster manager ###### Auto generated by spf13/cobra on 12-Aug-2016 From b3d167cfc27789fc5de43c98fcc957b65af5ac06 Mon Sep 17 00:00:00 2001 From: Derek Mahar Date: Tue, 20 Sep 2016 13:01:18 -0400 Subject: [PATCH 2/4] Correct name of secret in example in "Use-Case: Pod with ssh keys". In the example in section "Use-Case: Pod with ssh keys", change name of new SSH secret from "my-secret" to "ssh-key-secret" to match that in the subsequent pod specification that references the secret. --- docs/user-guide/secrets/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/secrets/index.md b/docs/user-guide/secrets/index.md index fff246c937..b0a1d32706 100644 --- a/docs/user-guide/secrets/index.md +++ b/docs/user-guide/secrets/index.md @@ -398,7 +398,7 @@ start until all the pod's volumes are mounted. Create a secret containing some ssh keys: ```shell -$ kubectl create secret generic my-secret --from-file=ssh-privatekey=/path/to/.ssh/id_rsa --from-file=ssh-publickey=/path/to/.ssh/id_rsa.pub +$ kubectl create secret generic ssh-key-secret --from-file=ssh-privatekey=/path/to/.ssh/id_rsa --from-file=ssh-publickey=/path/to/.ssh/id_rsa.pub ``` **Security Note:** think carefully before sending your own ssh keys: other users of the cluster may have access to the secret. Use a service account which you want to have accessible to all the users with whom you share the kubernetes cluster, and can revoke if they are compromised. From f7cba5c6ab39e14160db4ed6191e0d73cb1666c8 Mon Sep 17 00:00:00 2001 From: a-mccarthy Date: Tue, 20 Sep 2016 16:37:08 -0400 Subject: [PATCH 3/4] Create ISSUE_TEMPLATE.md Created issue template. --- ISSUE_TEMPLATE.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 0000000000..a0656931f0 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,22 @@ + + + + +**This is a...** + +- [ ] Feature Request +- [ ] Bug Report + +**Problem:** + + +**Proposed Solution:** + + +**Page to Update:** +http://kubernetes.io/... + + + + + From 6d4ea99b12888f5b2ae33aaef17809d0b20f7eb9 Mon Sep 17 00:00:00 2001 From: Jeff Mendoza Date: Tue, 20 Sep 2016 10:17:53 -0700 Subject: [PATCH 4/4] Move staging container to gcr, check in Dockerfile. --- README.md | 6 +++--- docs/templatedemos/index.md | 6 +++--- staging-container/Dockerfile | 13 +++++++++++++ 3 files changed, 19 insertions(+), 6 deletions(-) create mode 100644 staging-container/Dockerfile diff --git a/README.md b/README.md index a5c774ba66..e2fc558f9d 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ change the name of the fork to be: YOUR_GITHUB_USERNAME.github.io -Then make your changes. +Then make your changes. 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. @@ -21,11 +21,11 @@ Don't like installing stuff? Download and run a local staging server with a sing git clone https://github.com/kubernetes/kubernetes.github.io.git cd kubernetes.github.io - docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 johndmulhausen/k8sdocs + docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.0 Then visit [http://localhost:4000](http://localhost:4000) to see our site. Any changes you make on your local machine will be automatically staged. -If you're interested you can view [the Dockerfile for this image](https://gist.github.com/johndmulhausen/f8f0ab8d82d2c755af3a4709729e1859). +If you're interested you can view [the Dockerfile for this image](https://github.com/kubernetes/kubernetes.github.io/blob/master/staging-container/Dockerfile). ## Staging the site locally (from scratch setup) diff --git a/docs/templatedemos/index.md b/docs/templatedemos/index.md index ad58731bd7..88a94159f1 100644 --- a/docs/templatedemos/index.md +++ b/docs/templatedemos/index.md @@ -37,14 +37,14 @@ git fetch upstream git reset --hard upstream/docsv2 ``` -### Step 3: Make sure you can serve rendered docs +### Step 3: Make sure you can serve rendered docs One option is to simply rename your fork's repo on GitHub.com to `yourusername.github.io`, which will auto-stage your commits at that URL. Or, just use Docker! Run this from within your local `kubernetes.github.io` directory and you should be good: ```shell -docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 johndmulhausen/k8sdocs +docker run -ti --rm -v "$PWD":/k8sdocs -p 4000:4000 gcr.io/google-samples/k8sdocs:1.0 ``` The site will then be viewable at [http://localhost:4000/](http://localhost:4000/). @@ -246,4 +246,4 @@ You probably shouldn't be using this, but we also have templates which consume Y ### Adding page to navigation -Once your page is saved, somewhere in the `/docs/` directory, add a reference to the `reference.yml` file under `/_data/` so that it will appear in the left-hand navigation of the site. This is also where you add a title to the page. \ No newline at end of file +Once your page is saved, somewhere in the `/docs/` directory, add a reference to the `reference.yml` file under `/_data/` so that it will appear in the left-hand navigation of the site. This is also where you add a title to the page. diff --git a/staging-container/Dockerfile b/staging-container/Dockerfile new file mode 100644 index 0000000000..a5b41625b5 --- /dev/null +++ b/staging-container/Dockerfile @@ -0,0 +1,13 @@ +FROM starefossen/ruby-node:2-4 + +RUN gem install github-pages + +VOLUME /k8sdocs + +EXPOSE 4000 + +WORKDIR /k8sdocs + +CMD bundle && jekyll clean && jekyll serve -H 0.0.0.0 -P 4000 + +# For instructions, see http://kubernetes.io/editdocs/