-
Notifications
You must be signed in to change notification settings - Fork 14.3k
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.
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
Fix update documentation reference to doc location #1247
Conversation
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). 📝 Please visit https://cla.developers.google.com/ to sign. Once you've signed, please reply here (e.g.
|
I signed it! |
CLAs look good, thanks! |
$ cd kubernetes | ||
$ ./cluster/kube-up.sh | ||
$ git clone https://github.com/kubernetes/kubernetes.github.io | ||
$ cd kubernetes.github.io |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
$ cd kubernetes | ||
$ ./cluster/kube-up.sh | ||
$ git clone https://github.com/kubernetes/kubernetes.github.io | ||
$ cd kubernetes.github.io | ||
``` |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
Thanks for submitting the fix! I have a few comments. |
It seems docs were moved from kubernetes repo and now live in the website repo. I've updated the update-demo docs to work again with actual references.
I've submitted a new patch that solves the issues you pointed out in the comments. |
@janetkuo it looks like we will also need to create a release-1.3 branch as there is none currently but many docs refer to the release-1.3 branch |
We recently deleted release-1.3 branch, and it breaks these {{page.docsbranch}} links :( @kubernetes/docs |
The change LGTM but the link needs to be reviewed by the tech writers |
|
||
```shell | ||
$ cd kubernetes | ||
$ ./cluster/kube-up.sh | ||
$ git clone -b {{page.docsbranch}} https://github.com/kubernetes/kubernetes.github.io |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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..
I'd prefer we just change to |
@jeffmendoza I originally thought about doing that also and went with that first, but then noticed that we also have a command to run |
I'd rather go with @jeffmendoza 's suggestion. |
@devin-donnelly I too prefer jeff's suggestions and would happily update the patch to accommodate improvements, but currently @jeffmendoza has not yet provided an answer to the issue with his suggestion. Please provide a way to run kubectl proxy without cloning the repo. If there is a way to run kubectl proxy without cloning the repo, then we can utilize jeff's suggestion, if there is no such way then I suggest to use this patch as is and clone the user docs repo in the assumption step. |
Ah, yes. The proxy command requires the files to be local. LGTM Thanks! |
Co-authored-by: cpretzer <cpretzer@users.noreply.github.com>
…n) (kubernetes#1463) * Settings and initial contents for German localization (kubernetes#347) * first shot * WIP german contribution index file * finalized contribution index, add de.toml * add contentDir to de config section in config.toml * change request from catherine * finalizing style guide * change request from David and Catherine Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * [de] Fix typo in _index.md * first shot * change requests * [de] Add localization cloud computing (kubernetes#711) * [de] Add localization cloud computing * [de] Add missing title meta inf * [de] Adjust wording in cloud computing * [de] Adjust wording cloud computing Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * update terms to completed (kubernetes#725) * update terms to completed * Update content/de/agile_software_development.md Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com> * Update cloud_computing.md Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com> * localize feedback section * [de] Fix template title for agile software dev (kubernetes#731) * Add german translation for API Gateway (kubernetes#732) * Add german translation for API Gateway Add german translation for API Gateway. Solves kubernetes#507 * Update api_gateway.md fixed all found typos by * Update api_gateway.md small wording adjustment, changes state Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * [de] Add localization for "abstraction" * [de] Remove whitespaces * [de] Remove redundant information * [de] Rephrase sentence * [de] Rephrase sentence * [de] Remove white spaces * [de] Add localization cloud native tech * Incorporate suggested change Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * Incorporate suggested change Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * Incorporate suggested change Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * Incorporate suggested change to title * Update cloud_native_tech.md * rename files, add semantic line breaks, empty lines (kubernetes#974) * rename files, add semantic line breaks, empty lines Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * [DE] Take Over Cloud Native Security localization (kubernetes#990) * add cloud native sec Signed-off-by: Max Körbächer <m.koerbaecher@reply.de> Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * edits, semantic line breaks Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * change requests from Jihoon Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * change requests from david Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * change requests from david Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * Update content/de/cloud-native-security.md Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * Update content/de/cloud-native-security.md Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Co-authored-by: Max Körbächer <m.koerbaecher@reply.de> Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * german localize cloud native apps (kubernetes#1085) * add german localisation for cloud native apps * add .md * Apply suggestions from code review Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * apply change requests - remove redundancy * Update content/de/cloud-native-apps.md Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * Update content/de/cloud-native-apps.md Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Co-authored-by: David Wagner <daw@dataone.de> Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * [DE] Add german definition for canary deployment (kubernetes#1247) * [de] Add german definition for canary deployment Signed-off-by: Baris Cubukcuoglu <cubukcuoglu.baris@gmail.com> Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * Update content/de/canary_deployment.md Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> * Update content/de/canary_deployment.md Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> * Update content/de/canary_deployment.md Signed-off-by: Noah Ispas <Noahispas@gmail.com> Signed-off-by: Baris Cubukcuoglu <cubukcuoglu.baris@gmail.com> Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Co-authored-by: Noah Ispas <Noahispas@gmail.com> Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * german autoscaling localization (kubernetes#1111) * add german autoscaling localisation * Update content/de/autoscaling.md Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * Update content/de/autoscaling.md Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * Update content/de/autoscaling.md Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * change requests * Update content/de/autoscaling.md Signed-off-by: Noah Ispas <Noahispas@gmail.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> Co-authored-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Co-authored-by: Noah Ispas <Noahispas@gmail.com> * corrects filename Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * correct wording (kubernetes#1355) Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * [localization/german] Add localization for API (kubernetes#1055) * [localization/german] Add localization for API Co-authored-by: Noah Ispas <Noahispas@gmail.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * fix filename Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * [DE] Localization of Blue Green Deployment (kubernetes#1342) * first shot Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * localize headers Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * Update content/de/blue-green-deployment.md Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> * Update content/de/blue-green-deployment.md Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> * Update content/de/blue-green-deployment.md Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> * Update content/de/blue-green-deployment.md Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> * add change requests from Baris Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> * change every article state to completed Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> * extend information about initializing members of german content Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> Signed-off-by: Noah Ispas (iamNoah1) <noahispas@gmail.com> Signed-off-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Signed-off-by: Noah Ispas <13436814+iamNoah1@users.noreply.github.com> Signed-off-by: Baris Cubukcuoglu <cubukcuoglu.baris@gmail.com> Signed-off-by: Noah Ispas <Noahispas@gmail.com> Co-authored-by: Dennis Groß <gdennis91@googlemail.com> Co-authored-by: Jihoon Seo <46767780+jihoon-seo@users.noreply.github.com> Co-authored-by: Christian Hüning <christianhuening@users.noreply.github.com> Co-authored-by: Oliver L <oliver@pattern.engineer> Co-authored-by: Max Körbächer <m.koerbaecher@reply.de> Co-authored-by: DaveVentura <47860237+DaveVentura@users.noreply.github.com> Co-authored-by: David Wagner <daw@dataone.de> Co-authored-by: Baris Cubukcuoglu <cubukcuoglu.baris@googlemail.com>
It seems docs were moved from kubernetes repo and now
live in the website repo. I've updated the prequisite to
reflect this change.
This change is