Skip to content
New issue

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

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

[UI] Getting started page for hosted pipelines #2935

Merged
merged 9 commits into from
Jan 31, 2020

Conversation

Bobgy
Copy link
Contributor

@Bobgy Bobgy commented Jan 30, 2020

UPDATE: also implemented layout similar to designed documentation
UPDATE2: adjusted page title
localhost_3000_ (1)
Content of this page is purely rendered from markdown here: https://github.com/kubeflow/pipelines/pull/2935/files#diff-1e8357336f0f74b158fbf0751ac2d9daR31. So it's super easy for anyone to update later.

demo when feature flag turned on: https://drive.google.com/file/d/12dyaTLQY3AvwG38YC3TmBhCGOYqSUmGg/view

Changes:

  1. Add a separate getting started page for tfx usage (exact content of this page is merely a copy from [WIP] UI changes for pipeline landing page #2928 implemented requested layout, please adjust content with markdown based on further discussion).
  2. Add a feature flag for pipelines in gcp marketplace. (ml-pipeline-ui deployment with env variable DEPLOYMENT=MARKETPLACE will turn on this new feature.)
  3. Only show 1. when the feature flag is on.

Feature flag verification:

  1. built a frontend image using this branch
  2. swapped the image in a ml-pipeline-ui deployment and changed env var to DEPLOYMENT=MARKETPLACE
  3. verified getting started page shows
  4. edited deployment again to change env var to DEPLOYMENT=KUBEFLOW
  5. verified getting started page is hidden

This supercedes #2928.

/assign @SinaChavoshi


This change is Reviewable

@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 30, 2020

/approve

@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 30, 2020

/test kubeflow-pipeline-e2e-test

@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 30, 2020

/test kubeflow-pipeline-sample-test

strange, flakiness rate of workload identity seems to be higher than before

Copy link
Contributor

@SinaChavoshi SinaChavoshi left a comment

Choose a reason for hiding this comment

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

/lgtml

frontend/src/pages/GettingStarted.tsx Outdated Show resolved Hide resolved
@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 30, 2020

/retest

1 similar comment
@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 30, 2020

/retest

@SinaChavoshi
Copy link
Contributor

/lgtm

@sarahmaddox
Copy link
Contributor

/assign @joeliedtke

Thanks for asking for a tech writer review, @Ark-kun! I've assigned @joeliedtke, as he's now the tech writer for Pipelines. (I'm continuing as the Kubeflow tech writer overall.)

@sarahmaddox
Copy link
Contributor

/uncc

@k8s-ci-robot k8s-ci-robot removed the request for review from sarahmaddox January 30, 2020 20:29
@Ark-kun
Copy link
Contributor

Ark-kun commented Jan 30, 2020

Thank you for adding this page!

The page looks nice and useful, but I've noticed that it misses a link to the Pipelines documentation (https://www.kubeflow.org/docs/pipelines/), the Quickstart, the Getting Started guide etc. We might want to link to that helpful information.

/cc @sarahmaddox @amygdala @paveldournov

@jessiezcc
Copy link
Contributor

Thanks @Bobgy for this PR, it looks great!
For pipelines page, does it only show user uploaded pipeline or will it still show demo/tutorial pipelines?

@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 31, 2020

@Ark-kun, FYI, the page is currently only a mockup to demonstrate markdown. I expect a separate PR to adjust the exact content.

@jessiezcc, pipelines page still shows preloaded pipelines. I don't see how we can distinguish preloaded from user uploaded. So that's something I couldn't implement now.

@jessiezcc
Copy link
Contributor

for now, can we differentiate using prefix such as [demo], [tutorial]? WDUT, @SinaChavoshi ?
this way, end user will be able to customer their demo/tutorial list by just using the naming convention as well.

@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 31, 2020

@jessiezcc thanks for the idea. I think that's doable, but would need quite some efforts. I'm not sure I can fit that in current time frame.

Also, when I was trying to test filtering, found a bug with it: #2945. We should fix this before beta.

@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 31, 2020

Note, content of this getting started page is purely rendered from markdown here: https://github.com/kubeflow/pipelines/pull/2935/files#diff-1e8357336f0f74b158fbf0751ac2d9daR31. So it's super easy for anyone to update later.

I suggest we get this merged and let someone in US time work on the final tech writings. So that communication loop would be minimized. @SinaChavoshi can I ask you for that?

@jessiezcc
Copy link
Contributor

agree, let's check in this first

@k8s-ci-robot k8s-ci-robot removed the lgtm label Jan 31, 2020
@Bobgy
Copy link
Contributor Author

Bobgy commented Jan 31, 2020

@rmgogogo @IronPan for approval, because this includes marketplace manifest change too.

@SinaChavoshi
Copy link
Contributor

Yuan thank you again for all the work, +1 lets get this in as is. We can do quick follow up to adjust the UI before build cut off date today. As Yuan mentioned changes from here will be trivial.

@SinaChavoshi
Copy link
Contributor

/lgtm

@neuromage
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Bobgy, neuromage

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 4709c6b into kubeflow:master Jan 31, 2020
Jeffwan pushed a commit to Jeffwan/pipelines that referenced this pull request Dec 9, 2020
* Implement getting started page.

* Add feature flag to only show getting started page on hosted pipelines

* Add tests

* Fix format

* Implement requested layout in getting started page

* Minor adjust layout

* Fix tests

* Fix snapshots

* Update page title
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants