Refactor getting started - streamlined hierarchy #1051
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
A number of changes / benefits: 1) eliminated some duplicate information 2) added three main top level areas for installation: - cloud - workstation / server - existing kubernetes 3) Adding workstation operating systems - there are some slight variances in experience. For instance, for MacOS, we can emphasize brew to install some of the assets. For Windows, we'll want to add WSL2, and potentially chocolatey.
|
/assign |
sarahmaddox
suggested changes
Aug 9, 2019
There was a problem hiding this comment.
Thanks for this PR! I've added some review comments. A couple of other things to address as well:
-
To fix any incoming links: For every page that you've moved:
- Add a redirect for each moved page in this file: https://github.com/kubeflow/website/blob/master/content/_redirects (see instructions at top of file)
- Search the website codebase and change all affected links.
-
Revert the following file from the PR:
resources/_gen/assets/js/js/search.js_b4bb3e7b21b43e920b7c367ff787d383.content. (It's a weird consequence of the way we use Hugo, that this file appears sometimes and needs to be ignored.)
content/docs/started/cloud/_index.md
Outdated
| @@ -0,0 +1,5 @@ | |||
| +++ | |||
| title = "Cloud Install" | |||
There was a problem hiding this comment.
Change "Install" to "Installation" here and in all similar locations. ("Install" is a verb whereas "installation" is the noun.)
There was a problem hiding this comment.
Got it. Will be addressed in the next update to this PR.
| and according to your needs add additional CPUs.) | ||
| * Node with storage >= 10 GB. (Due to the ML libraries and third party packages | ||
| bundled in the Kubeflow Docker images.) | ||
| * Installing Kubeflow on a **Desktop** or **Server**: <a id="node"> |
There was a problem hiding this comment.
s/Desktop/desktop
s/Server/server
To avoid confusion, it's best to use lower case wherever possible, and upper case for brand names only.
The Kubeflow style guide has useful info about this and other hints for improving clarity of the docs.
There was a problem hiding this comment.
Got it. Will be addressed in the next update to this PR.
|
|
||
| <!-- Propose to refactor this into the windows / mac / linux pages |
There was a problem hiding this comment.
Is the refactoring complete? (I see some relevant info in the Windows page.) If yes, remove this comment as it's confusing. If no, then keep the comment but move the end-comment tag so that it doesn't hide the info.
There was a problem hiding this comment.
Refactoring is complete .. have removed the commented text.
| Kubernetes](/docs/started/k8s/overview/). | ||
| * If you want to run Kubernetes locally in a virtual machine (VM), choose one of | ||
| the following options: | ||
| * To use Kubeflow on Windows, |
There was a problem hiding this comment.
These links are broken.
There was a problem hiding this comment.
Thx, Fixed the links in this page
| [kustomize component guide](/docs/components/misc/kustomize/) | ||
| for details about installing kustomize. | ||
| There are various ways to install Kubeflow. Choose one of the following options | ||
| to suit your environment ([desktop or server](#node), [Kubernetes cluster or public cloud](#cloud)): |
There was a problem hiding this comment.
Remove the links here. They're a little confusing and distracting, as they link to sections immediately below.
There was a problem hiding this comment.
Got it. Will be addressed in the next update to the PR.
| more quickly | ||
| --> | ||
|
|
||
| ## Introduction |
There was a problem hiding this comment.
I think you can remove the heading "Introduction" and just have the introductory sentence as a nice lead-in to this page.
| TODO: Surface the mac specific instructions here .. for instance, installing | ||
| vagrant and virtualbox through brew / brew cask | ||
| --> | ||
|
|
There was a problem hiding this comment.
Add an introductory sentence as a nice lead-in to this page, as you did in the Linux guide.
| TODO: Surface the windows specific instructions here. For instance, when WSL2 is | ||
| available more broadly, add instructions here. | ||
| --> | ||
|
|
There was a problem hiding this comment.
Add an introductory sentence as a nice lead-in to this page, as you did in the Linux guide.
There was a problem hiding this comment.
Done, and I've added a comment about WSL 2
| <!-- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- --> | ||
| <!-- At this point, the user should be directed to "installing on an existing cluster" --> | ||
| <!-- ------- ------- ------- ------- ------- ------- ------- ------- ------- ------- --> | ||
|
|
There was a problem hiding this comment.
Is this something you're still planning to do on this page? Either remove the comment or add the required link.
There was a problem hiding this comment.
I have added the link to the "existing kubernetes cluster" getting started, and have removed the outdated instructions here.
| @@ -0,0 +1,5 @@ | |||
| +++ | |||
| title = "Workstation Install" | |||
There was a problem hiding this comment.
Change "Install" (verb) to "Installation" (noun).
|
I really like this PR - thanks for all the work on it! It goes a long way to addressing #889 /cc @yanniszark |
|
@sarahmaddox: GitHub didn't allow me to request PR reviews from the following users: DanSanche. Note that only kubeflow members and repo collaborators can review this PR, and authors cannot review their own PRs. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
|
Thanks @carmine for putting this PR together. /assign @cspavlou |
|
@yanniszark: GitHub didn't allow me to assign the following users: cspavlou. Note that only kubeflow members, repo collaborators and people who have commented on this issue/PR can be assigned. Additionally, issues/PRs can only have 10 assignees at the same time. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
cspavlou
suggested changes
Aug 9, 2019
| @@ -0,0 +1,5 @@ | |||
| +++ | |||
| title = "Workstation Appliances" | |||
| description = "Detailed instructions for leveraging VM appliances for Kubeflow" | |||
There was a problem hiding this comment.
I really like the structure based on the operating system. That's why I think that the Workstation Appliances section in not needed here. A user will just select the preferred guide based on their OS.
There was a problem hiding this comment.
I can move this directory to the reference section .. otherwise it'll remain in this subtree. Also, there might be a better word (ie not Appliance). Any thoughts on that?
There was a problem hiding this comment.
+1, I think this section should be moved out of the subtree for clarity sake
As for the naming, I've never heard the term appliance used in this context. What about something like "Workstation Kubernetes" or "Local Dev Environments"?
There was a problem hiding this comment.
Okay, I'll move this directory to Reference, and I'll change the name to Local Dev Environments. Let's see how that looks.
There was a problem hiding this comment.
Actually, I'm thinking Virtual Developer Environments seems most appropriate.
| For Linux systems you have options for servers and desktops. The server options apply to | ||
| the desktop as well. | ||
|
|
||
| ## Linux Server |
There was a problem hiding this comment.
I think it would make sense to have the desktop section before the server section. Most of the users would like to install Kubeflow on a laptop.
There was a problem hiding this comment.
In general, I agree - ie I think the Desktop could be more prevalent. The counter-argument is that a developer uses a VM in the cloud for this, particularly for web-based interaction (ie jupyter). I don't have data to substantiate which will be more popular. The only reason I put the server section up top is because the section is small. An alternative is to describe this up top and provide a link. What do you think?
|
|
||
| - Install [Vagrant](https://www.vagrantup.com/downloads.html) | ||
| - Install [Virtual Box](https://www.virtualbox.org/wiki/Downloads) | ||
|
|
There was a problem hiding this comment.
Can you restore the MiniKF description as it was on the Getting Started page?
MiniKF is a fast and easy way to get started with Kubeflow. It installs with just two commands and then you are up for experimentation, and for running complete Kubeflow Pipelines. It runs on all major operating systems (macOS, Windows, Linux).
There was a problem hiding this comment.
I thought I had selected the whole description, but GitHub's multi-line review doesn't seem to work as expected.
There was a problem hiding this comment.
I'm thinking of abbreviating this section further, drawing inspiration from the existing Kubernetes section. On that page a table is used, with each row providing a brief description of what the option is and then a pointer to the maintained page. Similar to that page, I'd like to avoid adjectives, and provide the complete set of instructions - ie in this scenario, that Vagrant and VirtualBox is required.
|
|
||
| - Install [Vagrant](https://www.vagrantup.com/downloads.html) | ||
| - Install [Virtual Box](https://www.virtualbox.org/wiki/Downloads) | ||
|
|
There was a problem hiding this comment.
same as above, can you restore the MiniKF description as it was on the Getting Started page?
MiniKF is a fast and easy way to get started with Kubeflow. It installs with just two commands and then you are up for experimentation, and for running complete Kubeflow Pipelines. It runs on all major operating systems (macOS, Windows, Linux).
There was a problem hiding this comment.
same here, I thought I had selected the whole description, but GitHub's multi-line review doesn't seem to work as expected.
|
|
||
| - Install [Vagrant](https://www.vagrantup.com/downloads.html) | ||
| - Install [Virtual Box](https://www.virtualbox.org/wiki/Downloads) | ||
|
|
There was a problem hiding this comment.
same as above, can you restore the MiniKF description as it was on the Getting Started page?
MiniKF is a fast and easy way to get started with Kubeflow. It installs with just two commands and then you are up for experimentation, and for running complete Kubeflow Pipelines. It runs on all major operating systems (macOS, Windows, Linux).
There was a problem hiding this comment.
same here, I thought I had selected the whole description, but GitHub's multi-line review doesn't seem to work as expected.
There was a problem hiding this comment.
Similar to comments in linux section, providing a table here (or simple / abbreviated list) may be more helpful for the reader. With other Windows options rapidly approaching, a concentrated / condensed list should provide lower cognitive load.
yanniszark
suggested changes
Aug 9, 2019
There was a problem hiding this comment.
@carmine thanks for this PR!
I have left some comments about small changes.
| --> | ||
|
|
||
|
|
||
| * Installing Kubeflow on a **Kubernetes Cluster** or a **Public Cloud**: <a id="cloud"> |
There was a problem hiding this comment.
Kubeflow is always installed on a Kubernetes Cluster, so this wording seems a bit confusing.
Maybe we can change it to:
Installing Kubeflow on an **existing Kubernetes cluster**
There was a problem hiding this comment.
I struggled with this as well. I've added existing.
|
|
||
| * Installing Kubeflow on a **Kubernetes Cluster** or a **Public Cloud**: <a id="cloud"> | ||
|
|
||
| * Installing Kubeflow on a Kubernetes cluster, follow the |
There was a problem hiding this comment.
Same as above,
Kubeflow on an existing Kubernetes cluster
content/docs/started/k8s/overview.md
Outdated
| * A minimum of 0.6 CPU in cluster. (Reserved for 3 replicated ambassador pods | ||
| and according to your needs add additional CPUs.) | ||
| * Node with storage >= 10 GB. (Due to the ML libraries and third party packages | ||
| bundled in the Kubeflow Docker images.) |
There was a problem hiding this comment.
The requirement for only 0.6 CPU seems outdated, my experience is that Kubeflow is much more resource intensive.
In addition, ambassador has been replaced by Istio so we should probably remove the parenthesis referring to it.
There was a problem hiding this comment.
I've cleaned up this section to better match the information on minikube, minikf and multipass.
|
I think this PR is a huge improvement; i.e. adding a level to the hierarchy to group solutions. I'm totally ok with going with the sections in this PR and then continuing to iterate in the future. The question that comes to mind for the different subsections (e.g. Cloud vs. workstations vs. Kubernetes Install) what are the different groups that we want want to convey? Some things to consider
I might suggest the following
|
This commit holds a set of minor changes that were requested in kubeflow#1051
Moving the VM instructions out of getting started directory tree so that the navigation bar remains clean / less busy.
|
I think this PR is close to being ready to merge, and then we can iterate on further improvements in later PRs. It looks to me like all reviewers agree the PR is a big improvement on the existing getting-started section. (Please excuse and correct me if I've missed a review comment that still needs addressing before merge.) One thing needs fixing before merge: There are a couple of minor things I'll fix up immediately after merge: I'll add some redirects for the pages we've moved, and I'd like to move the "Virtual Developer Environments" pages out of "reference" into "other guides". But I'm happy to get this PR merged first. |
A previous commit deleted the resources/_gen/assets/*/search*.content file. This commit adds it back in. Additionally, fixed the grammar in k8s/_index.md
|
@sarahmaddox - I've added the deleted file back in. My apologies for deleting in the first place - from the path name, it looked like something that I might have added accidentally. My read is that this PR is a net improvement, and I think we'll iterate again after this merge. |
|
Thanks @carmine /lgtm |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: sarahmaddox The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
numerology
pushed a commit
to numerology/website
that referenced
this pull request
Aug 21, 2019
commit a601bc0 Author: Oleg Butuzov <butuzov@users.noreply.github.com> Date: Wed Aug 21 02:25:17 2019 +0300 markdown formatting fix. (kubeflow#1088) this fix changes markdown formating for link to `/docs/started/k8s/overview` page, that currently broken on the website. see - https://www.kubeflow.org/docs/other-guides/virtual-dev/getting-started-minikube/ commit 48955d4 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Tue Aug 20 09:49:32 2019 +0800 Update kubeflow pipelines upgrade guide for kubeflow 0.6 (kubeflow#1055) * Fix kfp upgrade/reinstall preparation guide. * Update upgrade instructions for kubeflow deployment. * Remove kfp upgrade related instructions because they don't work * Rephrase PV to PD to be more accurate commit 384368d Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 20 10:23:33 2019 +1000 Clarified the usage reporting guide (kubeflow#1087) * Clarified usage reporting guide. * Clarified and added section formatting. * Changed word component to application * Changed another "component" to "application" commit 564e460 Author: Yuval Yaari <7331634+yuval-yaari@users.noreply.github.com> Date: Sun Aug 18 03:46:04 2019 +0000 Fixing command to retrieve the existing Dex configmap (kubeflow#1086) commit 1a863f4 Author: Leilei Hu <leileihu@cn.ibm.com> Date: Sat Aug 17 15:58:06 2019 -0400 Modify the out of date guide docs. (kubeflow#1085) commit 5248a15 Author: Yannis Zarkadas <yanniszark@arrikto.com> Date: Sat Aug 17 06:16:08 2019 +0300 pinconfig links for v0.6 to v0.6-branch (kubeflow#1071) Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com> commit 0f480d3 Author: Adhita Selvaraj <adhita94@gmail.com> Date: Fri Aug 16 14:14:09 2019 -0700 Update kfctl-k8s-istio.md (kubeflow#1044) * Update kfctl-k8s-istio.md Update script for quickly curling the latest release. Similar to kustomize: https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md#quickly-curl-the-latest * Keep both versions for install instructions commit 09e44c2 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Sat Aug 17 06:38:09 2019 +1000 Clarified port forwarding and auth for GCP (kubeflow#1083) * Clarifies port forwarding and auth for GCP. * Fixed formatting. * Addressed review comments. commit a8d9887 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Fri Aug 16 08:12:34 2019 +0800 Update pipeline quickstart for kf 0.6 (kubeflow#1080) commit 1654842 Author: cliveseldon <cc@seldon.io> Date: Fri Aug 16 00:54:34 2019 +0100 Update Seldon docs (kubeflow#1073) * Update Seldon docs * Update docs based on review commit 1b9e0d6 Author: Jiaxin Shan <seedjeffwan@gmail.com> Date: Wed Aug 14 19:44:33 2019 -0700 Merge installation guidance for new and existing cluster (kubeflow#1072) * Merge installation guidance for new and existing cluster * Address code review feedbacks commit 2b5c19a Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 15 12:30:33 2019 +1000 Change will to may in metadata warning. (kubeflow#1078) commit 8177767 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 13 17:03:39 2019 +1000 Expanded docs for the Metadata component (kubeflow#1061) * WIP Expanded docs for Metadata component. * Added more about metadata. * Addressed review comments. commit 5b6caa1 Author: Jeremy Lewi <jeremy+github@lewi.us> Date: Mon Aug 12 18:33:37 2019 -0700 Fix port-forarding instructions; port-forward to istio gateway (kubeflow#1067) * Fix port-forarding instructions; port-forward to istio gateway See kubeflow#1041 and kubeflow/kubeflow#3618 * With 0.6 if no auth is setup and you want to connect via port-forwarding then you need to port-forward to the ISTIO gateway; not ambassador * I suspect the original suggestion in kubeflow#1041 to port-forward to Ambassador only worked in the basic auth setting in which case we are still setting up Ambassador. Fix: kubeflow#1041 * Cleanup the text. commit 2d9564c Author: Zhenghui Wang <zhenghuiwang@users.noreply.github.com> Date: Mon Aug 12 17:41:38 2019 -0700 Add metadata API reference doc (kubeflow#1058) * add metadata API spec * add link to metadata doc page * address comments * remove metadata.md commit d01f2cb Author: Christos S. Pavlou <cspavlou@arrikto.com> Date: Tue Aug 13 00:25:38 2019 +0300 Amend the kfctl_existing_arrikto doc (kubeflow#1056) Add instructions for installing MetalLB Add `Troubleshooting` section Add architecture figure Change the kfctl_existing_arrikto description in the Overview page Signed-off-by: Christos S. Pavlou <cspavlou@arrikto.com> commit 85ba5bb Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 13 02:15:13 2019 +1000 Refactored 'Other Guides' and applied redirects. (kubeflow#1064) commit cf7b9f3 Author: Jiaxiao Zheng <jxzheng@google.com> Date: Sun Aug 11 18:21:10 2019 -0700 Fix broken links. (kubeflow#1060) commit 40a3f49 Author: Carmine Rimi <carmine.rimi@canonical.com> Date: Sun Aug 11 19:43:10 2019 -0400 Refactor getting started - streamlined hierarchy (kubeflow#1051) * Refactor getting started - streamlined hierarchy A number of changes / benefits: 1) eliminated some duplicate information 2) added three main top level areas for installation: - cloud - workstation / server - existing kubernetes 3) Adding workstation operating systems - there are some slight variances in experience. For instance, for MacOS, we can emphasize brew to install some of the assets. For Windows, we'll want to add WSL2, and potentially chocolatey. * Updated PR kubeflow#1051 with recommended changes This commit holds a set of minor changes that were requested in kubeflow#1051 * Move VM based local workstation to reference Moving the VM instructions out of getting started directory tree so that the navigation bar remains clean / less busy. * Add deleted assets files, reword k8s _index A previous commit deleted the resources/_gen/assets/*/search*.content file. This commit adds it back in. Additionally, fixed the grammar in k8s/_index.md commit 05d3d92 Author: Ning <ngao@google.com> Date: Fri Aug 9 21:51:13 2019 -0700 update sample link after kfp sample restructure (kubeflow#1057) commit 9c7fcd8 Author: IronPan <yangpa@google.com> Date: Fri Aug 9 20:33:13 2019 -0700 Update pipeline API version (kubeflow#1054) * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * Update deploy-pipelines-service.md * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * comment * format * update kf version * update deployment wording * update deployment wording * update deployment wording * update commit 61de916 Author: Lun-Kai Hsu <lunkai@google.com> Date: Fri Aug 9 16:35:14 2019 -0700 Fix tfserving doc (kubeflow#1025) * fix tfserving doc * fix * fix commit 0823f78 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Sat Aug 10 06:51:13 2019 +1000 Updated screenshots and UI info for Kubeflow v0.6 (kubeflow#1029) * WIP Updating screenshots and UI info for v0.6 * Fixed UI text and URLs in pipelines quickstart. * Fixed UI text and clarified Cloud Shell in Pipelines tutorial. * Removed screenshot of Kubeflow central UI as it doesn't show TFJob. * Started updates to notebooks. * Updated port-forwarding instructions for UI. * Updated UI for notebooks. * Finished UI updates for notebooks. * Fixed caps in URL variable. commit cc50aca Author: Ed Henry <edward.m.henry@gmail.com> Date: Thu Aug 8 21:41:24 2019 -0700 xgboost url update (kubeflow#1052) * xgboost url update Pipeline overview doc reflected a stale URL. This commit updates to the correct URL of the xgboost-spark directory of the Kubeflow repo. * Remove docsy submodule Removing the docsy submodule commit ca09f1f Author: Jiaxin Shan <seedjeffwan@gmail.com> Date: Thu Aug 8 20:33:25 2019 -0700 Update aws docs for 0.6 release (kubeflow#1030) * Update aws docs for 0.6 release * Address code review feedbacks * Update indents to render markdown * Remove shell in code blocks * Fix indent issue * Make existing cluster solution more clear commit d09cecc Author: Krishna Durai <krishnadurai20@gmail.com> Date: Fri Aug 9 08:55:25 2019 +0530 Instructions on setting up dynamic volume provisioner (kubeflow#1040) * Instructions on setting up dynamic volume provisioner Resolves kubeflow/kubeflow#3774 * Clarifies what to delete * Rearranges and clarifies descriptions * Re-arranges and rephrases content * Fixes link Corrects description * Addresses review comments commit f557a0e Author: Hougang Liu <liuhoug@cn.ibm.com> Date: Thu Aug 8 12:27:16 2019 +0800 Update katib Dockerfile locations link (kubeflow#1049) commit 0b03ae0 Author: Abhishek Gupta <abhishek@google.com> Date: Wed Aug 7 21:19:17 2019 -0700 Update to include limitations and integrations (kubeflow#1047) commit beefae9 Author: Michael Benavidez <MBenavidez@gmail.com> Date: Wed Aug 7 09:02:51 2019 -0700 PR for Issue 795 (outdated Pipelines SDK guide) (kubeflow#971) * Update pipelines-tutorial.md * Add files via upload * Update kubeflow-current-version.html * Delete kubeflow-current-version.html Unnecessary, kf-stable-tag already serves this purpose. * Update pipelines-tutorial.md * Update pipelines-tutorial.md * Update pipelines-tutorial.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md commit 2f5356c Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Wed Aug 7 10:32:53 2019 +0800 Fix other js features broken by heading anchor link. (kubeflow#1039) commit c36ace3 Author: Jin Chi He <hejinchi@cn.ibm.com> Date: Wed Aug 7 09:24:53 2019 +0800 fix mini problem in fairing doc (kubeflow#1031) commit 670f8b4 Author: Leilei Hu <leileihu@cn.ibm.com> Date: Tue Aug 6 21:18:51 2019 -0400 Fix docs link 404 errors. (kubeflow#1032) commit ef6374a Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Wed Aug 7 10:28:52 2019 +1000 Added redirect and fixed links to getting-started guide for existing clusters (kubeflow#1035) * Added redirect and fixed links to existing-custer getting-started guide. * Added empty line at end of file. commit dda2f0c Author: Sarah Maddox <sarahmaddox@google.com> Date: Sun Aug 4 06:23:28 2019 +1000 Added a warning. commit d27e54b Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:53:22 2019 +1000 Fixed a typo. commit 1a5bd1b Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:48:50 2019 +1000 Fixed a couple more links. commit 065a133 Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:35:45 2019 +1000 Added page for shared components and resources commit 70bda37 Author: Johnu George <johnugeorge109@gmail.com> Date: Tue Aug 6 22:57:56 2019 +0530 Fixing doc for KF installation on existing clusters (kubeflow#977) * Fixing doc for existing clusters * Update authentication.md * Update getting-started-k8s.md * Update getting-started-k8s.md * Address review comments * Minor changes * Address review comments * Address review comments * Minor title change * Fix path commit 63b34cb Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 6 13:55:53 2019 +1000 Fixed up the GCP deployment guide for CLI v0.6 (kubeflow#1021) * WIP Fixing up the GCP deployment guide for CLI. * Further updates during CLI deployment testing. * More tweaks to wording for clarity. commit 39bf96e Author: Scott Lee <scottilee@users.noreply.github.com> Date: Mon Aug 5 19:39:53 2019 -0700 Add references to kustomize issues (kubeflow#1015) commit f1f3a59 Author: Eric Lilienstein <5490671+elilienstein@users.noreply.github.com> Date: Mon Aug 5 18:53:54 2019 -0700 Deployment UI requires project id, not name (kubeflow#1028) Following the instructions above: - go to https://deploy.kubeflow.cloud - enter previously created GCP project name and other required information - click 'Create Deployment' Result: An error message indicates that the project can't be located. The required information was the project ID, not the project name commit f3d9c3a Author: Amy <amyu@google.com> Date: Mon Aug 5 17:43:54 2019 -0700 typo fix (kubeflow#1027) commit b3fb238 Author: Amy <amyu@google.com> Date: Mon Aug 5 15:19:49 2019 -0700 added a few clarifications to the GKE CLI installation instructions (kubeflow#1026) commit ecc9c5b Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Mon Aug 5 12:55:48 2019 +0800 Fix anchor icon color + formatting (kubeflow#1022) commit db5ad7e Author: Matt Callanan <mattcallanan@users.noreply.github.com> Date: Mon Aug 5 06:33:48 2019 +1000 Fixed link to xgboost-training-cm.py (kubeflow#1018) commit 89fd3f8 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Mon Aug 5 04:29:49 2019 +0800 Add anchor links to markdown headings. (kubeflow#1009) * Add anchor links automatically. * Improve anchor link UX * improve corner-case layout stability * improve a11y * Change link icon to material icon commit 1634ea3 Author: Abhishek Gupta <abhishek@google.com> Date: Fri Aug 2 15:43:54 2019 -0400 add owner role requirement in GCP project setup (kubeflow#1016) commit 1dd668e Author: Iman Tabrizian <tabrizian@outlook.com> Date: Fri Aug 2 01:15:52 2019 -0400 Add troubleshooting guide for notebooks (kubeflow#1008) * feat: add template of troubleshooting guide for notebooks * feat: improve the notebooks troubleshooting guide * fix: improve the note for GCP users * fix: minor bug in the link * fix: improve the troubleshooting guide * fix: fix troubleshooting guides commit 3bc674e Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 1 23:26:15 2019 +1000 Moved GCP Pipelines tutorial to GCP section of docs (kubeflow#1004) * Moved GCP Pipelines tutorial to GCP section of docs. * Addressed review comments. commit 38ab9cc Author: Ce Gao <gaoce@caicloud.io> Date: Thu Aug 1 09:42:14 2019 +0800 fix: Fix the repo (kubeflow#1005) * fix: Fix the repo Signed-off-by: Ce Gao <gaoce@caicloud.io> * fix: Fix the statement Signed-off-by: Ce Gao <gaoce@caicloud.io> commit 070a0ea Author: Ning <ngao@google.com> Date: Wed Jul 31 16:54:13 2019 -0700 minor fix (kubeflow#1007) commit be10697 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 1 03:18:14 2019 +1000 Added link from notebooks setup to multi-user isolation doc. (kubeflow#1001) commit 7b086d7 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Wed Jul 31 15:22:20 2019 +1000 Fixed links to tutorials and codelabs. (kubeflow#1003) commit e6eb291 Author: Jiaxiao Zheng <jxzheng@google.com> Date: Tue Jul 30 16:45:10 2019 -0700 Update customizing-gke.md (kubeflow#987) * Update customizing-gke.md Fix stale links. * Update customizing-gke.md Fix the links to cluster.jinja also commit 67f6edb Author: Jiaxiao Zheng <jxzheng@google.com> Date: Tue Jul 30 16:31:09 2019 -0700 Update customizing-gke.md (kubeflow#999) Correct a typo commit 395c848 Author: Zhenghui Wang <zhenghuiwang@users.noreply.github.com> Date: Mon Jul 29 17:21:38 2019 -0700 Update metadata.md change the minimum requirements for using Metadata components. commit 7f4beb7 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Jul 30 09:18:49 2019 +1000 Clarified versions available in deployment UI and CLI (kubeflow#981) * Clarified versions available in deployment UI and CLI. * Removed empty line at EOF because it causes a space in rendering on page. * Review comment Co-Authored-By: Dwight J Lyle <dwightjl@users.noreply.github.com> commit fae0bf9 Author: Karen Bradshaw <kbhawkey@gmail.com> Date: Mon Jul 29 17:58:49 2019 -0400 fix a few typos (kubeflow#985) - See kubeflow#936 - See kubeflow#982
k8s-ci-robot
pushed a commit
that referenced
this pull request
Sep 12, 2020
* Squashed commit of the following: commit a601bc0 Author: Oleg Butuzov <butuzov@users.noreply.github.com> Date: Wed Aug 21 02:25:17 2019 +0300 markdown formatting fix. (#1088) this fix changes markdown formating for link to `/docs/started/k8s/overview` page, that currently broken on the website. see - https://www.kubeflow.org/docs/other-guides/virtual-dev/getting-started-minikube/ commit 48955d4 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Tue Aug 20 09:49:32 2019 +0800 Update kubeflow pipelines upgrade guide for kubeflow 0.6 (#1055) * Fix kfp upgrade/reinstall preparation guide. * Update upgrade instructions for kubeflow deployment. * Remove kfp upgrade related instructions because they don't work * Rephrase PV to PD to be more accurate commit 384368d Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 20 10:23:33 2019 +1000 Clarified the usage reporting guide (#1087) * Clarified usage reporting guide. * Clarified and added section formatting. * Changed word component to application * Changed another "component" to "application" commit 564e460 Author: Yuval Yaari <7331634+yuval-yaari@users.noreply.github.com> Date: Sun Aug 18 03:46:04 2019 +0000 Fixing command to retrieve the existing Dex configmap (#1086) commit 1a863f4 Author: Leilei Hu <leileihu@cn.ibm.com> Date: Sat Aug 17 15:58:06 2019 -0400 Modify the out of date guide docs. (#1085) commit 5248a15 Author: Yannis Zarkadas <yanniszark@arrikto.com> Date: Sat Aug 17 06:16:08 2019 +0300 pinconfig links for v0.6 to v0.6-branch (#1071) Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com> commit 0f480d3 Author: Adhita Selvaraj <adhita94@gmail.com> Date: Fri Aug 16 14:14:09 2019 -0700 Update kfctl-k8s-istio.md (#1044) * Update kfctl-k8s-istio.md Update script for quickly curling the latest release. Similar to kustomize: https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md#quickly-curl-the-latest * Keep both versions for install instructions commit 09e44c2 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Sat Aug 17 06:38:09 2019 +1000 Clarified port forwarding and auth for GCP (#1083) * Clarifies port forwarding and auth for GCP. * Fixed formatting. * Addressed review comments. commit a8d9887 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Fri Aug 16 08:12:34 2019 +0800 Update pipeline quickstart for kf 0.6 (#1080) commit 1654842 Author: cliveseldon <cc@seldon.io> Date: Fri Aug 16 00:54:34 2019 +0100 Update Seldon docs (#1073) * Update Seldon docs * Update docs based on review commit 1b9e0d6 Author: Jiaxin Shan <seedjeffwan@gmail.com> Date: Wed Aug 14 19:44:33 2019 -0700 Merge installation guidance for new and existing cluster (#1072) * Merge installation guidance for new and existing cluster * Address code review feedbacks commit 2b5c19a Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 15 12:30:33 2019 +1000 Change will to may in metadata warning. (#1078) commit 8177767 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 13 17:03:39 2019 +1000 Expanded docs for the Metadata component (#1061) * WIP Expanded docs for Metadata component. * Added more about metadata. * Addressed review comments. commit 5b6caa1 Author: Jeremy Lewi <jeremy+github@lewi.us> Date: Mon Aug 12 18:33:37 2019 -0700 Fix port-forarding instructions; port-forward to istio gateway (#1067) * Fix port-forarding instructions; port-forward to istio gateway See #1041 and kubeflow/kubeflow#3618 * With 0.6 if no auth is setup and you want to connect via port-forwarding then you need to port-forward to the ISTIO gateway; not ambassador * I suspect the original suggestion in #1041 to port-forward to Ambassador only worked in the basic auth setting in which case we are still setting up Ambassador. Fix: #1041 * Cleanup the text. commit 2d9564c Author: Zhenghui Wang <zhenghuiwang@users.noreply.github.com> Date: Mon Aug 12 17:41:38 2019 -0700 Add metadata API reference doc (#1058) * add metadata API spec * add link to metadata doc page * address comments * remove metadata.md commit d01f2cb Author: Christos S. Pavlou <cspavlou@arrikto.com> Date: Tue Aug 13 00:25:38 2019 +0300 Amend the kfctl_existing_arrikto doc (#1056) Add instructions for installing MetalLB Add `Troubleshooting` section Add architecture figure Change the kfctl_existing_arrikto description in the Overview page Signed-off-by: Christos S. Pavlou <cspavlou@arrikto.com> commit 85ba5bb Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 13 02:15:13 2019 +1000 Refactored 'Other Guides' and applied redirects. (#1064) commit cf7b9f3 Author: Jiaxiao Zheng <jxzheng@google.com> Date: Sun Aug 11 18:21:10 2019 -0700 Fix broken links. (#1060) commit 40a3f49 Author: Carmine Rimi <carmine.rimi@canonical.com> Date: Sun Aug 11 19:43:10 2019 -0400 Refactor getting started - streamlined hierarchy (#1051) * Refactor getting started - streamlined hierarchy A number of changes / benefits: 1) eliminated some duplicate information 2) added three main top level areas for installation: - cloud - workstation / server - existing kubernetes 3) Adding workstation operating systems - there are some slight variances in experience. For instance, for MacOS, we can emphasize brew to install some of the assets. For Windows, we'll want to add WSL2, and potentially chocolatey. * Updated PR #1051 with recommended changes This commit holds a set of minor changes that were requested in #1051 * Move VM based local workstation to reference Moving the VM instructions out of getting started directory tree so that the navigation bar remains clean / less busy. * Add deleted assets files, reword k8s _index A previous commit deleted the resources/_gen/assets/*/search*.content file. This commit adds it back in. Additionally, fixed the grammar in k8s/_index.md commit 05d3d92 Author: Ning <ngao@google.com> Date: Fri Aug 9 21:51:13 2019 -0700 update sample link after kfp sample restructure (#1057) commit 9c7fcd8 Author: IronPan <yangpa@google.com> Date: Fri Aug 9 20:33:13 2019 -0700 Update pipeline API version (#1054) * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * Update deploy-pipelines-service.md * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * comment * format * update kf version * update deployment wording * update deployment wording * update deployment wording * update commit 61de916 Author: Lun-Kai Hsu <lunkai@google.com> Date: Fri Aug 9 16:35:14 2019 -0700 Fix tfserving doc (#1025) * fix tfserving doc * fix * fix commit 0823f78 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Sat Aug 10 06:51:13 2019 +1000 Updated screenshots and UI info for Kubeflow v0.6 (#1029) * WIP Updating screenshots and UI info for v0.6 * Fixed UI text and URLs in pipelines quickstart. * Fixed UI text and clarified Cloud Shell in Pipelines tutorial. * Removed screenshot of Kubeflow central UI as it doesn't show TFJob. * Started updates to notebooks. * Updated port-forwarding instructions for UI. * Updated UI for notebooks. * Finished UI updates for notebooks. * Fixed caps in URL variable. commit cc50aca Author: Ed Henry <edward.m.henry@gmail.com> Date: Thu Aug 8 21:41:24 2019 -0700 xgboost url update (#1052) * xgboost url update Pipeline overview doc reflected a stale URL. This commit updates to the correct URL of the xgboost-spark directory of the Kubeflow repo. * Remove docsy submodule Removing the docsy submodule commit ca09f1f Author: Jiaxin Shan <seedjeffwan@gmail.com> Date: Thu Aug 8 20:33:25 2019 -0700 Update aws docs for 0.6 release (#1030) * Update aws docs for 0.6 release * Address code review feedbacks * Update indents to render markdown * Remove shell in code blocks * Fix indent issue * Make existing cluster solution more clear commit d09cecc Author: Krishna Durai <krishnadurai20@gmail.com> Date: Fri Aug 9 08:55:25 2019 +0530 Instructions on setting up dynamic volume provisioner (#1040) * Instructions on setting up dynamic volume provisioner Resolves kubeflow/kubeflow#3774 * Clarifies what to delete * Rearranges and clarifies descriptions * Re-arranges and rephrases content * Fixes link Corrects description * Addresses review comments commit f557a0e Author: Hougang Liu <liuhoug@cn.ibm.com> Date: Thu Aug 8 12:27:16 2019 +0800 Update katib Dockerfile locations link (#1049) commit 0b03ae0 Author: Abhishek Gupta <abhishek@google.com> Date: Wed Aug 7 21:19:17 2019 -0700 Update to include limitations and integrations (#1047) commit beefae9 Author: Michael Benavidez <MBenavidez@gmail.com> Date: Wed Aug 7 09:02:51 2019 -0700 PR for Issue 795 (outdated Pipelines SDK guide) (#971) * Update pipelines-tutorial.md * Add files via upload * Update kubeflow-current-version.html * Delete kubeflow-current-version.html Unnecessary, kf-stable-tag already serves this purpose. * Update pipelines-tutorial.md * Update pipelines-tutorial.md * Update pipelines-tutorial.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md commit 2f5356c Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Wed Aug 7 10:32:53 2019 +0800 Fix other js features broken by heading anchor link. (#1039) commit c36ace3 Author: Jin Chi He <hejinchi@cn.ibm.com> Date: Wed Aug 7 09:24:53 2019 +0800 fix mini problem in fairing doc (#1031) commit 670f8b4 Author: Leilei Hu <leileihu@cn.ibm.com> Date: Tue Aug 6 21:18:51 2019 -0400 Fix docs link 404 errors. (#1032) commit ef6374a Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Wed Aug 7 10:28:52 2019 +1000 Added redirect and fixed links to getting-started guide for existing clusters (#1035) * Added redirect and fixed links to existing-custer getting-started guide. * Added empty line at end of file. commit dda2f0c Author: Sarah Maddox <sarahmaddox@google.com> Date: Sun Aug 4 06:23:28 2019 +1000 Added a warning. commit d27e54b Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:53:22 2019 +1000 Fixed a typo. commit 1a5bd1b Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:48:50 2019 +1000 Fixed a couple more links. commit 065a133 Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:35:45 2019 +1000 Added page for shared components and resources commit 70bda37 Author: Johnu George <johnugeorge109@gmail.com> Date: Tue Aug 6 22:57:56 2019 +0530 Fixing doc for KF installation on existing clusters (#977) * Fixing doc for existing clusters * Update authentication.md * Update getting-started-k8s.md * Update getting-started-k8s.md * Address review comments * Minor changes * Address review comments * Address review comments * Minor title change * Fix path commit 63b34cb Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 6 13:55:53 2019 +1000 Fixed up the GCP deployment guide for CLI v0.6 (#1021) * WIP Fixing up the GCP deployment guide for CLI. * Further updates during CLI deployment testing. * More tweaks to wording for clarity. commit 39bf96e Author: Scott Lee <scottilee@users.noreply.github.com> Date: Mon Aug 5 19:39:53 2019 -0700 Add references to kustomize issues (#1015) commit f1f3a59 Author: Eric Lilienstein <5490671+elilienstein@users.noreply.github.com> Date: Mon Aug 5 18:53:54 2019 -0700 Deployment UI requires project id, not name (#1028) Following the instructions above: - go to https://deploy.kubeflow.cloud - enter previously created GCP project name and other required information - click 'Create Deployment' Result: An error message indicates that the project can't be located. The required information was the project ID, not the project name commit f3d9c3a Author: Amy <amyu@google.com> Date: Mon Aug 5 17:43:54 2019 -0700 typo fix (#1027) commit b3fb238 Author: Amy <amyu@google.com> Date: Mon Aug 5 15:19:49 2019 -0700 added a few clarifications to the GKE CLI installation instructions (#1026) commit ecc9c5b Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Mon Aug 5 12:55:48 2019 +0800 Fix anchor icon color + formatting (#1022) commit db5ad7e Author: Matt Callanan <mattcallanan@users.noreply.github.com> Date: Mon Aug 5 06:33:48 2019 +1000 Fixed link to xgboost-training-cm.py (#1018) commit 89fd3f8 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Mon Aug 5 04:29:49 2019 +0800 Add anchor links to markdown headings. (#1009) * Add anchor links automatically. * Improve anchor link UX * improve corner-case layout stability * improve a11y * Change link icon to material icon commit 1634ea3 Author: Abhishek Gupta <abhishek@google.com> Date: Fri Aug 2 15:43:54 2019 -0400 add owner role requirement in GCP project setup (#1016) commit 1dd668e Author: Iman Tabrizian <tabrizian@outlook.com> Date: Fri Aug 2 01:15:52 2019 -0400 Add troubleshooting guide for notebooks (#1008) * feat: add template of troubleshooting guide for notebooks * feat: improve the notebooks troubleshooting guide * fix: improve the note for GCP users * fix: minor bug in the link * fix: improve the troubleshooting guide * fix: fix troubleshooting guides commit 3bc674e Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 1 23:26:15 2019 +1000 Moved GCP Pipelines tutorial to GCP section of docs (#1004) * Moved GCP Pipelines tutorial to GCP section of docs. * Addressed review comments. commit 38ab9cc Author: Ce Gao <gaoce@caicloud.io> Date: Thu Aug 1 09:42:14 2019 +0800 fix: Fix the repo (#1005) * fix: Fix the repo Signed-off-by: Ce Gao <gaoce@caicloud.io> * fix: Fix the statement Signed-off-by: Ce Gao <gaoce@caicloud.io> commit 070a0ea Author: Ning <ngao@google.com> Date: Wed Jul 31 16:54:13 2019 -0700 minor fix (#1007) commit be10697 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 1 03:18:14 2019 +1000 Added link from notebooks setup to multi-user isolation doc. (#1001) commit 7b086d7 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Wed Jul 31 15:22:20 2019 +1000 Fixed links to tutorials and codelabs. (#1003) commit e6eb291 Author: Jiaxiao Zheng <jxzheng@google.com> Date: Tue Jul 30 16:45:10 2019 -0700 Update customizing-gke.md (#987) * Update customizing-gke.md Fix stale links. * Update customizing-gke.md Fix the links to cluster.jinja also commit 67f6edb Author: Jiaxiao Zheng <jxzheng@google.com> Date: Tue Jul 30 16:31:09 2019 -0700 Update customizing-gke.md (#999) Correct a typo commit 395c848 Author: Zhenghui Wang <zhenghuiwang@users.noreply.github.com> Date: Mon Jul 29 17:21:38 2019 -0700 Update metadata.md change the minimum requirements for using Metadata components. commit 7f4beb7 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Jul 30 09:18:49 2019 +1000 Clarified versions available in deployment UI and CLI (#981) * Clarified versions available in deployment UI and CLI. * Removed empty line at EOF because it causes a space in rendering on page. * Review comment Co-Authored-By: Dwight J Lyle <dwightjl@users.noreply.github.com> commit fae0bf9 Author: Karen Bradshaw <kbhawkey@gmail.com> Date: Mon Jul 29 17:58:49 2019 -0400 fix a few typos (#985) - See #936 - See #982 * minor typo and update a screenshot. * Update central-ui.png and correct wording * Correct stale naming * Update pipeline ui screenshot * Update pipeline upload screenshot * Update three pictures. * SDK install page * pipeline param * lint and remove banner for type check in DSL * remove banner for real * gcp * recover image * fix typo * Apply PR comments
k8s-ci-robot
pushed a commit
that referenced
this pull request
Sep 14, 2020
* Squashed commit of the following: commit a601bc0 Author: Oleg Butuzov <butuzov@users.noreply.github.com> Date: Wed Aug 21 02:25:17 2019 +0300 markdown formatting fix. (#1088) this fix changes markdown formating for link to `/docs/started/k8s/overview` page, that currently broken on the website. see - https://www.kubeflow.org/docs/other-guides/virtual-dev/getting-started-minikube/ commit 48955d4 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Tue Aug 20 09:49:32 2019 +0800 Update kubeflow pipelines upgrade guide for kubeflow 0.6 (#1055) * Fix kfp upgrade/reinstall preparation guide. * Update upgrade instructions for kubeflow deployment. * Remove kfp upgrade related instructions because they don't work * Rephrase PV to PD to be more accurate commit 384368d Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 20 10:23:33 2019 +1000 Clarified the usage reporting guide (#1087) * Clarified usage reporting guide. * Clarified and added section formatting. * Changed word component to application * Changed another "component" to "application" commit 564e460 Author: Yuval Yaari <7331634+yuval-yaari@users.noreply.github.com> Date: Sun Aug 18 03:46:04 2019 +0000 Fixing command to retrieve the existing Dex configmap (#1086) commit 1a863f4 Author: Leilei Hu <leileihu@cn.ibm.com> Date: Sat Aug 17 15:58:06 2019 -0400 Modify the out of date guide docs. (#1085) commit 5248a15 Author: Yannis Zarkadas <yanniszark@arrikto.com> Date: Sat Aug 17 06:16:08 2019 +0300 pinconfig links for v0.6 to v0.6-branch (#1071) Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com> commit 0f480d3 Author: Adhita Selvaraj <adhita94@gmail.com> Date: Fri Aug 16 14:14:09 2019 -0700 Update kfctl-k8s-istio.md (#1044) * Update kfctl-k8s-istio.md Update script for quickly curling the latest release. Similar to kustomize: https://github.com/kubernetes-sigs/kustomize/blob/master/docs/INSTALL.md#quickly-curl-the-latest * Keep both versions for install instructions commit 09e44c2 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Sat Aug 17 06:38:09 2019 +1000 Clarified port forwarding and auth for GCP (#1083) * Clarifies port forwarding and auth for GCP. * Fixed formatting. * Addressed review comments. commit a8d9887 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Fri Aug 16 08:12:34 2019 +0800 Update pipeline quickstart for kf 0.6 (#1080) commit 1654842 Author: cliveseldon <cc@seldon.io> Date: Fri Aug 16 00:54:34 2019 +0100 Update Seldon docs (#1073) * Update Seldon docs * Update docs based on review commit 1b9e0d6 Author: Jiaxin Shan <seedjeffwan@gmail.com> Date: Wed Aug 14 19:44:33 2019 -0700 Merge installation guidance for new and existing cluster (#1072) * Merge installation guidance for new and existing cluster * Address code review feedbacks commit 2b5c19a Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 15 12:30:33 2019 +1000 Change will to may in metadata warning. (#1078) commit 8177767 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 13 17:03:39 2019 +1000 Expanded docs for the Metadata component (#1061) * WIP Expanded docs for Metadata component. * Added more about metadata. * Addressed review comments. commit 5b6caa1 Author: Jeremy Lewi <jeremy+github@lewi.us> Date: Mon Aug 12 18:33:37 2019 -0700 Fix port-forarding instructions; port-forward to istio gateway (#1067) * Fix port-forarding instructions; port-forward to istio gateway See #1041 and kubeflow/kubeflow#3618 * With 0.6 if no auth is setup and you want to connect via port-forwarding then you need to port-forward to the ISTIO gateway; not ambassador * I suspect the original suggestion in #1041 to port-forward to Ambassador only worked in the basic auth setting in which case we are still setting up Ambassador. Fix: #1041 * Cleanup the text. commit 2d9564c Author: Zhenghui Wang <zhenghuiwang@users.noreply.github.com> Date: Mon Aug 12 17:41:38 2019 -0700 Add metadata API reference doc (#1058) * add metadata API spec * add link to metadata doc page * address comments * remove metadata.md commit d01f2cb Author: Christos S. Pavlou <cspavlou@arrikto.com> Date: Tue Aug 13 00:25:38 2019 +0300 Amend the kfctl_existing_arrikto doc (#1056) Add instructions for installing MetalLB Add `Troubleshooting` section Add architecture figure Change the kfctl_existing_arrikto description in the Overview page Signed-off-by: Christos S. Pavlou <cspavlou@arrikto.com> commit 85ba5bb Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 13 02:15:13 2019 +1000 Refactored 'Other Guides' and applied redirects. (#1064) commit cf7b9f3 Author: Jiaxiao Zheng <jxzheng@google.com> Date: Sun Aug 11 18:21:10 2019 -0700 Fix broken links. (#1060) commit 40a3f49 Author: Carmine Rimi <carmine.rimi@canonical.com> Date: Sun Aug 11 19:43:10 2019 -0400 Refactor getting started - streamlined hierarchy (#1051) * Refactor getting started - streamlined hierarchy A number of changes / benefits: 1) eliminated some duplicate information 2) added three main top level areas for installation: - cloud - workstation / server - existing kubernetes 3) Adding workstation operating systems - there are some slight variances in experience. For instance, for MacOS, we can emphasize brew to install some of the assets. For Windows, we'll want to add WSL2, and potentially chocolatey. * Updated PR #1051 with recommended changes This commit holds a set of minor changes that were requested in #1051 * Move VM based local workstation to reference Moving the VM instructions out of getting started directory tree so that the navigation bar remains clean / less busy. * Add deleted assets files, reword k8s _index A previous commit deleted the resources/_gen/assets/*/search*.content file. This commit adds it back in. Additionally, fixed the grammar in k8s/_index.md commit 05d3d92 Author: Ning <ngao@google.com> Date: Fri Aug 9 21:51:13 2019 -0700 update sample link after kfp sample restructure (#1057) commit 9c7fcd8 Author: IronPan <yangpa@google.com> Date: Fri Aug 9 20:33:13 2019 -0700 Update pipeline API version (#1054) * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * Update deploy-pipelines-service.md * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * update pipeline deployment doc * comment * format * update kf version * update deployment wording * update deployment wording * update deployment wording * update commit 61de916 Author: Lun-Kai Hsu <lunkai@google.com> Date: Fri Aug 9 16:35:14 2019 -0700 Fix tfserving doc (#1025) * fix tfserving doc * fix * fix commit 0823f78 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Sat Aug 10 06:51:13 2019 +1000 Updated screenshots and UI info for Kubeflow v0.6 (#1029) * WIP Updating screenshots and UI info for v0.6 * Fixed UI text and URLs in pipelines quickstart. * Fixed UI text and clarified Cloud Shell in Pipelines tutorial. * Removed screenshot of Kubeflow central UI as it doesn't show TFJob. * Started updates to notebooks. * Updated port-forwarding instructions for UI. * Updated UI for notebooks. * Finished UI updates for notebooks. * Fixed caps in URL variable. commit cc50aca Author: Ed Henry <edward.m.henry@gmail.com> Date: Thu Aug 8 21:41:24 2019 -0700 xgboost url update (#1052) * xgboost url update Pipeline overview doc reflected a stale URL. This commit updates to the correct URL of the xgboost-spark directory of the Kubeflow repo. * Remove docsy submodule Removing the docsy submodule commit ca09f1f Author: Jiaxin Shan <seedjeffwan@gmail.com> Date: Thu Aug 8 20:33:25 2019 -0700 Update aws docs for 0.6 release (#1030) * Update aws docs for 0.6 release * Address code review feedbacks * Update indents to render markdown * Remove shell in code blocks * Fix indent issue * Make existing cluster solution more clear commit d09cecc Author: Krishna Durai <krishnadurai20@gmail.com> Date: Fri Aug 9 08:55:25 2019 +0530 Instructions on setting up dynamic volume provisioner (#1040) * Instructions on setting up dynamic volume provisioner Resolves kubeflow/kubeflow#3774 * Clarifies what to delete * Rearranges and clarifies descriptions * Re-arranges and rephrases content * Fixes link Corrects description * Addresses review comments commit f557a0e Author: Hougang Liu <liuhoug@cn.ibm.com> Date: Thu Aug 8 12:27:16 2019 +0800 Update katib Dockerfile locations link (#1049) commit 0b03ae0 Author: Abhishek Gupta <abhishek@google.com> Date: Wed Aug 7 21:19:17 2019 -0700 Update to include limitations and integrations (#1047) commit beefae9 Author: Michael Benavidez <MBenavidez@gmail.com> Date: Wed Aug 7 09:02:51 2019 -0700 PR for Issue 795 (outdated Pipelines SDK guide) (#971) * Update pipelines-tutorial.md * Add files via upload * Update kubeflow-current-version.html * Delete kubeflow-current-version.html Unnecessary, kf-stable-tag already serves this purpose. * Update pipelines-tutorial.md * Update pipelines-tutorial.md * Update pipelines-tutorial.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md * Update build-component.md commit 2f5356c Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Wed Aug 7 10:32:53 2019 +0800 Fix other js features broken by heading anchor link. (#1039) commit c36ace3 Author: Jin Chi He <hejinchi@cn.ibm.com> Date: Wed Aug 7 09:24:53 2019 +0800 fix mini problem in fairing doc (#1031) commit 670f8b4 Author: Leilei Hu <leileihu@cn.ibm.com> Date: Tue Aug 6 21:18:51 2019 -0400 Fix docs link 404 errors. (#1032) commit ef6374a Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Wed Aug 7 10:28:52 2019 +1000 Added redirect and fixed links to getting-started guide for existing clusters (#1035) * Added redirect and fixed links to existing-custer getting-started guide. * Added empty line at end of file. commit dda2f0c Author: Sarah Maddox <sarahmaddox@google.com> Date: Sun Aug 4 06:23:28 2019 +1000 Added a warning. commit d27e54b Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:53:22 2019 +1000 Fixed a typo. commit 1a5bd1b Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:48:50 2019 +1000 Fixed a couple more links. commit 065a133 Author: Sarah Maddox <sarahmaddox@google.com> Date: Fri Aug 2 10:35:45 2019 +1000 Added page for shared components and resources commit 70bda37 Author: Johnu George <johnugeorge109@gmail.com> Date: Tue Aug 6 22:57:56 2019 +0530 Fixing doc for KF installation on existing clusters (#977) * Fixing doc for existing clusters * Update authentication.md * Update getting-started-k8s.md * Update getting-started-k8s.md * Address review comments * Minor changes * Address review comments * Address review comments * Minor title change * Fix path commit 63b34cb Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Aug 6 13:55:53 2019 +1000 Fixed up the GCP deployment guide for CLI v0.6 (#1021) * WIP Fixing up the GCP deployment guide for CLI. * Further updates during CLI deployment testing. * More tweaks to wording for clarity. commit 39bf96e Author: Scott Lee <scottilee@users.noreply.github.com> Date: Mon Aug 5 19:39:53 2019 -0700 Add references to kustomize issues (#1015) commit f1f3a59 Author: Eric Lilienstein <5490671+elilienstein@users.noreply.github.com> Date: Mon Aug 5 18:53:54 2019 -0700 Deployment UI requires project id, not name (#1028) Following the instructions above: - go to https://deploy.kubeflow.cloud - enter previously created GCP project name and other required information - click 'Create Deployment' Result: An error message indicates that the project can't be located. The required information was the project ID, not the project name commit f3d9c3a Author: Amy <amyu@google.com> Date: Mon Aug 5 17:43:54 2019 -0700 typo fix (#1027) commit b3fb238 Author: Amy <amyu@google.com> Date: Mon Aug 5 15:19:49 2019 -0700 added a few clarifications to the GKE CLI installation instructions (#1026) commit ecc9c5b Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Mon Aug 5 12:55:48 2019 +0800 Fix anchor icon color + formatting (#1022) commit db5ad7e Author: Matt Callanan <mattcallanan@users.noreply.github.com> Date: Mon Aug 5 06:33:48 2019 +1000 Fixed link to xgboost-training-cm.py (#1018) commit 89fd3f8 Author: Yuan (Bob) Gong <gongyuan94@gmail.com> Date: Mon Aug 5 04:29:49 2019 +0800 Add anchor links to markdown headings. (#1009) * Add anchor links automatically. * Improve anchor link UX * improve corner-case layout stability * improve a11y * Change link icon to material icon commit 1634ea3 Author: Abhishek Gupta <abhishek@google.com> Date: Fri Aug 2 15:43:54 2019 -0400 add owner role requirement in GCP project setup (#1016) commit 1dd668e Author: Iman Tabrizian <tabrizian@outlook.com> Date: Fri Aug 2 01:15:52 2019 -0400 Add troubleshooting guide for notebooks (#1008) * feat: add template of troubleshooting guide for notebooks * feat: improve the notebooks troubleshooting guide * fix: improve the note for GCP users * fix: minor bug in the link * fix: improve the troubleshooting guide * fix: fix troubleshooting guides commit 3bc674e Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 1 23:26:15 2019 +1000 Moved GCP Pipelines tutorial to GCP section of docs (#1004) * Moved GCP Pipelines tutorial to GCP section of docs. * Addressed review comments. commit 38ab9cc Author: Ce Gao <gaoce@caicloud.io> Date: Thu Aug 1 09:42:14 2019 +0800 fix: Fix the repo (#1005) * fix: Fix the repo Signed-off-by: Ce Gao <gaoce@caicloud.io> * fix: Fix the statement Signed-off-by: Ce Gao <gaoce@caicloud.io> commit 070a0ea Author: Ning <ngao@google.com> Date: Wed Jul 31 16:54:13 2019 -0700 minor fix (#1007) commit be10697 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Thu Aug 1 03:18:14 2019 +1000 Added link from notebooks setup to multi-user isolation doc. (#1001) commit 7b086d7 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Wed Jul 31 15:22:20 2019 +1000 Fixed links to tutorials and codelabs. (#1003) commit e6eb291 Author: Jiaxiao Zheng <jxzheng@google.com> Date: Tue Jul 30 16:45:10 2019 -0700 Update customizing-gke.md (#987) * Update customizing-gke.md Fix stale links. * Update customizing-gke.md Fix the links to cluster.jinja also commit 67f6edb Author: Jiaxiao Zheng <jxzheng@google.com> Date: Tue Jul 30 16:31:09 2019 -0700 Update customizing-gke.md (#999) Correct a typo commit 395c848 Author: Zhenghui Wang <zhenghuiwang@users.noreply.github.com> Date: Mon Jul 29 17:21:38 2019 -0700 Update metadata.md change the minimum requirements for using Metadata components. commit 7f4beb7 Author: Sarah Maddox <sarahmaddox@users.noreply.github.com> Date: Tue Jul 30 09:18:49 2019 +1000 Clarified versions available in deployment UI and CLI (#981) * Clarified versions available in deployment UI and CLI. * Removed empty line at EOF because it causes a space in rendering on page. * Review comment Co-Authored-By: Dwight J Lyle <dwightjl@users.noreply.github.com> commit fae0bf9 Author: Karen Bradshaw <kbhawkey@gmail.com> Date: Mon Jul 29 17:58:49 2019 -0400 fix a few typos (#985) - See #936 - See #982 * minor typo and update a screenshot. * Update central-ui.png and correct wording * Correct stale naming * Update pipeline ui screenshot * Update pipeline upload screenshot * Update three pictures. * correct compiler part, and add clarification to ContainerOp * placeholders for titles * add parfor, exithandler, condition * update Client * notebook * removed alert * remove deprecated notebook section * fixes images * applied comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR should fix #1043, #1045, #1046
A number of changes/benefits:
variances in experience. For instance, for MacOS, we can emphasize
brew to install some of the assets. For Windows, we'll want to add
WSL2, and potentially chocolatey.
This change is