refactor "Installing Kubeflow" page #2611

thesuperzapper · 2021-04-14T14:19:30Z

Closes #2590

As discussed in Issue #2590, this is a rewrite for the "Installing Kubeflow" page.

thesuperzapper · 2021-04-14T14:24:21Z

@RFMVasconcelos @cvenets

content/en/docs/started/installing-kubeflow.md

joeliedtke

Added a few suggestions

content/en/docs/started/installing-kubeflow.md

shannonbradshaw · 2021-04-19T23:26:47Z

@joeliedtke I think maybe you want to take a look at my PR instead. Most of what you're commenting on, I've already fixed on here: #2625

thesuperzapper · 2021-04-20T00:12:39Z

@RFMVasconcelos @joeliedtke I have made changes based off the comments, any further thoughts?

After we agree on the bullet points under each section, we can write the actual text.

rui-vas

@thesuperzapper thank you for leading this! I have left a few comments throughout :)

content/en/docs/started/installing-kubeflow.md

rui-vas · 2021-04-21T08:56:33Z

@thesuperzapper Thank you for your last commits, this is shaping up to be a great overview! 🎉

Please see this comment. Aside from that, I think we are ready to write the missing descriptions and effectively merge this. WDYT?

rui-vas

@shannonbradshaw I think we should update this page centrally here. I have adapted pieces from your #2625 PR to complete this one so we can maximize output and take advantage of everyone's willingness to contribute.

@thesuperzapper can you review the text proposals and, with your edits, commit so we can get to a final PR?

content/en/docs/started/installing-kubeflow.md

shannonbradshaw · 2021-04-21T10:21:00Z

@shannonbradshaw I think we should update this page centrally here. I have adapted pieces from your #2625 PR to complete this one so we can maximize output and take advantage of everyone's willingness to contribute.

@RFMVasconcelos sounds good! Thanks for all the work, @thesuperzapper and @RFMVasconcelos.

content/en/docs/started/installing-kubeflow.md

thesuperzapper · 2021-04-22T01:34:43Z

@RFMVasconcelos I have incorporated your suggestions, and I think this is ready to /approve.

Obviously we will iterate on this page, but we should try and get this merged very soon, so it can be linked to in the 1.3 blogs.

shannonbradshaw · 2021-04-22T02:28:28Z

@thesuperzapper Arrikto Enterprise Kubeflow should be listed among the distributions. Asking that we include at:
distributions/ekf/_index.md

with the text below

`+++
title = "Arrikto Enterprise Kubeflow"
description = "Kubeflow distribution with additional automation, reproducibility, portability, and security features"
weight = 50
+++

The Arrikto Enterprise Kubeflow (EKF) distribution extends the capabilities of the Kubeflow platform with additional automation, reproducibility, portability, and security features.

Automation: Orchestrate your end-to-end ML workflow with a click of a button. Start by tagging cells in Jupyter Notebooks to define pipeline steps, hyperparameter tuning, GPU usage, and metrics tracking. Click a button to create pipeline components and KFP DSL, resolve dependencies, inject data objects into each step, deploy the data science pipeline, and serve the best model. Or use the Kale SDK to do all the above with your preferred IDE.
Reproducibility: Snapshot pipeline code, libraries, and data for every step with Arrikto’s Rok data management platform. Roll back to any machine learning pipeline step at it’s exact execution state for easy debugging. Collaborate with other data scientists through a Git-style publish/subscribe versioning workflow.
Portability: Deploy and upgrade your Kubeflow environment with a proven GitOps process across all major public clouds, and on-prem infrastructure. Move ML workflows seamlessly across with Rok Registry.
Security: Manage teams and user access via GitLab or any ID provider via Istio/OIDC. Isolate user ML data access within their own namespace while enabling notebook and pipeline collaboration in shared namespaces. Manage secrets and credentials securely, and efficiently.
`

shannonbradshaw · 2021-04-22T02:29:57Z

@thesuperzapper the column values for the table entry for the EKF distribution should be:
Arrikto Enterprise Kubeflow | Arrikto | EKS, AKS, GKE | link to page created using text from my previous comment

shannonbradshaw

@thesuperzapper, requesting a few changes.

content/en/docs/started/installing-kubeflow.md

shannonbradshaw · 2021-04-22T02:37:34Z

content/en/docs/started/installing-kubeflow.md

+      </tr>
+      <tr>
+        <td>Kubeflow on Openshift</td>
+        <td>IBM Cloud</td>


Currently, this distribution is maintained by IBM Cloud, (not RedHat) @animeshsingh can verify.

content/en/docs/started/installing-kubeflow.md

shannonbradshaw · 2021-04-22T02:43:57Z

content/en/docs/started/installing-kubeflow.md

+        <td>Cloud Marketplaces, Vagrant</td>
+        <td><a href="/docs/distributions/minikf/">Docs</a></td>
+        <td></td>
+      </tr>


<tr> <td><a href="/docs/distributions/ekf/">Arrikto Enterprise Kubeflow</a></td> <td>Arrikto</td> <td>EKS, AKS, GKE </td> </tr>

Lets keep this PR to refactoring what was already there, if you want to add another doc page, you can just raise a PR which updates the "Installing Kubeflow" page, after this has been merged.

content/en/docs/started/installing-kubeflow.md

thesuperzapper · 2021-04-22T03:20:30Z

@shannonbradshaw you mentioned wanting to add the "Arrikto Enterprise Kubeflow" distribution, please raise a separate PR (after this one is merged), as this PR is only for refactoring the "Installing Kubeflow" page, not adding a new distribution doc.

thesuperzapper · 2021-04-22T07:18:37Z

@RFMVasconcelos I think this is good enough to merge now so we have a proper "Installing Kubeflow" page up by the time 1.3 is dropped tonight.

We can keep iterating on it over the next while if needed.

rui-vas

@thesuperzapper @shannonbradshaw for the interest of time I agree with @thesuperzapper that we should merge this and then keep on iterating in further PRs.

For reference, this will merge to the master branch. For these changes to be effective we need @Bobgy or @joeliedtke to change the config in netlify so that the website points to that branch.

/lgtm
/approve

content/en/docs/started/installing-kubeflow.md

google-oss-robot · 2021-04-22T08:48:01Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: RFMVasconcelos, thesuperzapper

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:

~~content/en/docs/started/OWNERS~~ [RFMVasconcelos]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Bobgy · 2021-04-22T08:59:50Z

Adding some late comments:

[blocker] I think we are missing a redirect rule from the old page to the new page
[blocker] https://deploy-preview-2611--competent-brattain-de2d6d.netlify.app/docs/started/getting-started/ is broken, we should update the "getting started" button url
the link to manifest README should better pin to 1.3.0 release once we pin the final release
I think we should add a column "Issue Tracker" where people can report distribution specific issues.

EDIT: 1 and 2 already fixed by #2635

Bobgy · 2021-04-22T09:03:03Z

I really love where this is going and appreciate the efforts!
Thank you @thesuperzapper @shannonbradshaw @RFMVasconcelos!

rui-vas · 2021-04-22T09:45:55Z

Sorry if I prematurely merged this one @Bobgy, but wanted to accelerate the progress, allowing iteration in further PRs. :)

Blockers:

I noticed and fixed this in rename getting started to fix broken link #2635, was a BIG problem 😂
Also fixed in rename getting started to fix broken link #2635 (I think, please verify :) )
+1
+1 - too many columns may wrap but I think this would be useful! We can find a sensible way to make it fit.

WIP refactor of "Installing Kubeflow"

e9ab89e

google-oss-robot added the do-not-merge/work-in-progress label Apr 14, 2021

google-cla bot added the cla: yes label Apr 14, 2021

google-oss-robot requested review from Bobgy and knkski April 14, 2021 14:19

google-oss-robot added the size/L label Apr 14, 2021

thesuperzapper mentioned this pull request Apr 14, 2021

Refactor the "Getting Started" "Installing Kubeflow" page #2590

Closed

rui-vas reviewed Apr 14, 2021

View reviewed changes

joeliedtke reviewed Apr 19, 2021

View reviewed changes

thesuperzapper added 3 commits April 20, 2021 10:02

temp 1

8849036

temp 2

4c6847d

temp 3

eb08fae

Bobgy mentioned this pull request Apr 20, 2021

Refactor getting started #2625

Closed

rui-vas reviewed Apr 20, 2021

View reviewed changes

thesuperzapper mentioned this pull request Apr 21, 2021

remove distribution docs from kubeflow.org #2629

Closed

thesuperzapper added 2 commits April 21, 2021 12:02

temp 4

637ffe9

temp 5

e438170

rui-vas reviewed Apr 21, 2021

View reviewed changes

content/en/docs/started/installing-kubeflow.md Outdated Show resolved Hide resolved

content/en/docs/started/installing-kubeflow.md Show resolved Hide resolved

content/en/docs/started/installing-kubeflow.md Outdated Show resolved Hide resolved

rui-vas mentioned this pull request Apr 21, 2021

Kubeflow 1.3 release doc updates #2546

Closed

zijianjoy reviewed Apr 21, 2021

View reviewed changes

content/en/docs/started/installing-kubeflow.md Show resolved Hide resolved

content/en/docs/started/installing-kubeflow.md Outdated Show resolved Hide resolved

thesuperzapper added 4 commits April 22, 2021 10:52

temp 6

09c4fd7

temp 7

bfd22fd

temp 8

57590d2

temp 9

2b8adfc

thesuperzapper added 2 commits April 22, 2021 11:22

temp 10

b8fc6c8

temp 11

0fa360a

thesuperzapper changed the title ~~[WIP] refactor of "Installing Kubeflow"~~ refactor "Installing Kubeflow" page Apr 22, 2021

google-oss-robot removed the do-not-merge/work-in-progress label Apr 22, 2021

temp 12

ca38ad3

thesuperzapper mentioned this pull request Apr 22, 2021

remove "Getting Started"/"Workstation Installation" #2605

Merged

shannonbradshaw suggested changes Apr 22, 2021

View reviewed changes

shannonbradshaw reviewed Apr 22, 2021

View reviewed changes

content/en/docs/started/installing-kubeflow.md Outdated Show resolved Hide resolved

thesuperzapper added 2 commits April 22, 2021 13:14

temp 13

86df859

temp 14

b4ac352

temp 15

92f930b

rui-vas reviewed Apr 22, 2021

View reviewed changes

content/en/docs/started/installing-kubeflow.md Show resolved Hide resolved

content/en/docs/started/installing-kubeflow.md Show resolved Hide resolved

google-oss-robot assigned rui-vas Apr 22, 2021

google-oss-robot added the lgtm label Apr 22, 2021

google-oss-robot added the approved label Apr 22, 2021

google-oss-robot merged commit 20d53c6 into kubeflow:master Apr 22, 2021

shannonbradshaw mentioned this pull request Apr 22, 2021

Add ekf distro #2641

Merged

cvenets mentioned this pull request Apr 22, 2021

Installation page: Roll your own option should be first, distributions should follow #2644

Closed

thesuperzapper deleted the refactor_install_kubeflow branch November 22, 2023 22:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor "Installing Kubeflow" page #2611

refactor "Installing Kubeflow" page #2611

thesuperzapper commented Apr 14, 2021

thesuperzapper commented Apr 14, 2021

joeliedtke left a comment

shannonbradshaw commented Apr 19, 2021 •

edited

Loading

thesuperzapper commented Apr 20, 2021

rui-vas left a comment

rui-vas commented Apr 21, 2021

rui-vas left a comment

shannonbradshaw commented Apr 21, 2021

thesuperzapper commented Apr 22, 2021

shannonbradshaw commented Apr 22, 2021 •

edited

Loading

shannonbradshaw commented Apr 22, 2021 •

edited

Loading

shannonbradshaw left a comment •

edited

Loading

shannonbradshaw Apr 22, 2021

thesuperzapper Apr 22, 2021

shannonbradshaw Apr 22, 2021

thesuperzapper Apr 22, 2021

thesuperzapper commented Apr 22, 2021

thesuperzapper commented Apr 22, 2021

rui-vas left a comment

google-oss-robot commented Apr 22, 2021

Bobgy commented Apr 22, 2021 •

edited

Loading

Bobgy commented Apr 22, 2021

rui-vas commented Apr 22, 2021

refactor "Installing Kubeflow" page #2611

refactor "Installing Kubeflow" page #2611

Conversation

thesuperzapper commented Apr 14, 2021

thesuperzapper commented Apr 14, 2021

joeliedtke left a comment

Choose a reason for hiding this comment

shannonbradshaw commented Apr 19, 2021 • edited Loading

thesuperzapper commented Apr 20, 2021

rui-vas left a comment

Choose a reason for hiding this comment

rui-vas commented Apr 21, 2021

rui-vas left a comment

Choose a reason for hiding this comment

shannonbradshaw commented Apr 21, 2021

thesuperzapper commented Apr 22, 2021

shannonbradshaw commented Apr 22, 2021 • edited Loading

shannonbradshaw commented Apr 22, 2021 • edited Loading

shannonbradshaw left a comment • edited Loading

Choose a reason for hiding this comment

shannonbradshaw Apr 22, 2021

Choose a reason for hiding this comment

thesuperzapper Apr 22, 2021

Choose a reason for hiding this comment

shannonbradshaw Apr 22, 2021

Choose a reason for hiding this comment

thesuperzapper Apr 22, 2021

Choose a reason for hiding this comment

thesuperzapper commented Apr 22, 2021

thesuperzapper commented Apr 22, 2021

rui-vas left a comment

Choose a reason for hiding this comment

google-oss-robot commented Apr 22, 2021

Bobgy commented Apr 22, 2021 • edited Loading

Bobgy commented Apr 22, 2021

rui-vas commented Apr 22, 2021

shannonbradshaw commented Apr 19, 2021 •

edited

Loading

shannonbradshaw commented Apr 22, 2021 •

edited

Loading

shannonbradshaw commented Apr 22, 2021 •

edited

Loading

shannonbradshaw left a comment •

edited

Loading

Bobgy commented Apr 22, 2021 •

edited

Loading