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

Document alternative deploy method of Kubeflow Pipelines #1174

Merged
merged 12 commits into from
Oct 17, 2019

Conversation

Bobgy
Copy link
Contributor

@Bobgy Bobgy commented Sep 26, 2019

@jessiezcc @IronPan can you help me review/find someone to help me review this?
The new page can be found at https://deploy-preview-1174--competent-brattain-de2d6d.netlify.com/docs/pipelines/deployment-alternatives/


This change is Reviewable

@Bobgy
Copy link
Contributor Author

Bobgy commented Sep 26, 2019

This is part of kubeflow/pipelines#1638

@jingzhang36
Copy link
Contributor

/lgtm

@k8s-ci-robot k8s-ci-robot removed the lgtm label Sep 27, 2019
@Bobgy
Copy link
Contributor Author

Bobgy commented Sep 28, 2019

/assign @IronPan

@sarahmaddox
Copy link
Contributor

/assign

Copy link
Contributor

@sarahmaddox sarahmaddox left a comment

Choose a reason for hiding this comment

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

Thanks for creating this doc! I've made some suggestions for improved clarity and readability

content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/pipelines-deploy-alternatives.md Outdated Show resolved Hide resolved
@Bobgy
Copy link
Contributor Author

Bobgy commented Oct 1, 2019

Hi @sarahmaddox, thanks a lot for the detailed review! It's really helpful to me because I'm not a native speaker of English.

I'm currently on vacation, will follow up with fixes after Oct. 7

@sarahmaddox
Copy link
Contributor

@sarahmaddox
Copy link
Contributor

/lgtm
/approve
/hold

Thanks @Bobgy! This doc LGTM. I've added a hold, to give @IronPan and @jingzhang36 the opportunity to review the page too.

@Bobgy
Copy link
Contributor Author

Bobgy commented Oct 10, 2019

@sarahmaddox thanks for the detailed review and approval! @jingzhang36 has already LGTMed. I'm waiting for the team to decide on a consistent branding.

@k8s-ci-robot k8s-ci-robot removed the lgtm label Oct 12, 2019
@Bobgy
Copy link
Contributor Author

Bobgy commented Oct 12, 2019

@IronPan reminder, do you want to review this?

Especially, can you take a look at this one #1174 (comment)?

@Bobgy
Copy link
Contributor Author

Bobgy commented Oct 12, 2019

/hold cancel
This is ready to merge after @IronPan reviews

content/docs/pipelines/deployment-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/deployment-alternatives.md Outdated Show resolved Hide resolved

1. Deploy latest version of Kubeflow Pipelines:
```
export PIPELINE_VERSION={{% kfp-latest-version %}}
Copy link
Member

Choose a reason for hiding this comment

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

who will be maintaining kfp-latest-version?
alternatively we could publish the file to gs://ml-pipeline/pipeline-lite/latest/namespaced-install.yaml
and refer from there.
wdyt?

Copy link
Contributor Author

@Bobgy Bobgy Oct 15, 2019

Choose a reason for hiding this comment

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

I think it's important we make the version explicit, it affects what command they use to delete it.
What do you think about adding an extra step to our release book?

Copy link
Contributor

Choose a reason for hiding this comment

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

+1 to making the version explicit, and to adding the step to the release book. (Doc updates should be part of each release, and part of each feature-development task.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

discussed, I will add this to release book

content/docs/pipelines/deployment-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/deployment-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/deployment-alternatives.md Outdated Show resolved Hide resolved
content/docs/pipelines/deployment-alternatives.md Outdated Show resolved Hide resolved
@Bobgy
Copy link
Contributor Author

Bobgy commented Oct 17, 2019

Hi @sarahmaddox @IronPan, thanks for the suggestions.

I've updated the doc:

  • with instructions to create gcp cluster
  • remove alternatives
  • retarget the doc to gcp only

@sarahmaddox
Copy link
Contributor

content/docs/pipelines/standalone-deployment-gcp.md Outdated Show resolved Hide resolved
content/docs/pipelines/standalone-deployment-gcp.md Outdated Show resolved Hide resolved
content/docs/pipelines/standalone-deployment-gcp.md Outdated Show resolved Hide resolved
content/docs/pipelines/standalone-deployment-gcp.md Outdated Show resolved Hide resolved
content/docs/pipelines/standalone-deployment-gcp.md Outdated Show resolved Hide resolved
@sarahmaddox
Copy link
Contributor

Thanks for these changes @Bobgy! There are just a few formatting things to fix up before we can publish the doc. Once it's published, we can iterate on a bit more polishing. It'll be good to get this doc out there for people to use.

@Bobgy
Copy link
Contributor Author

Bobgy commented Oct 17, 2019

Thanks for the review @sarahmaddox! I've made suggested changes. Please take a brief review again.

Copy link
Contributor

@sarahmaddox sarahmaddox left a comment

Choose a reason for hiding this comment

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

One more formatting issue to fix.

@sarahmaddox
Copy link
Contributor

Thanks!
/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

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

@k8s-ci-robot k8s-ci-robot merged commit adc6dbb into kubeflow:master Oct 17, 2019
yanniszark pushed a commit to yanniszark/website that referenced this pull request Oct 23, 2019
)

* initial

* Document alternative deploy method of Kubeflow Pipelines

* adjust wording

* Adjust wording to give more context of choices user have

* Change kubectl apply -k to use github url, make it easier to understand where the manifest is

* Improvements based on Sarah's review

* Update KFP lite branding to KFP standalone

* Update to make the doc GCP specific

* Update gcp create cluster guide

* Rename deployment-alternatives doc to standalone deployment gcp

* Address review comments

* Update standalone-deployment-gcp.md
yanniszark pushed a commit to yanniszark/website that referenced this pull request Oct 23, 2019
)

* initial

* Document alternative deploy method of Kubeflow Pipelines

* adjust wording

* Adjust wording to give more context of choices user have

* Change kubectl apply -k to use github url, make it easier to understand where the manifest is

* Improvements based on Sarah's review

* Update KFP lite branding to KFP standalone

* Update to make the doc GCP specific

* Update gcp create cluster guide

* Rename deployment-alternatives doc to standalone deployment gcp

* Address review comments

* Update standalone-deployment-gcp.md
yanniszark pushed a commit to yanniszark/website that referenced this pull request Oct 23, 2019
)

* initial

* Document alternative deploy method of Kubeflow Pipelines

* adjust wording

* Adjust wording to give more context of choices user have

* Change kubectl apply -k to use github url, make it easier to understand where the manifest is

* Improvements based on Sarah's review

* Update KFP lite branding to KFP standalone

* Update to make the doc GCP specific

* Update gcp create cluster guide

* Rename deployment-alternatives doc to standalone deployment gcp

* Address review comments

* Update standalone-deployment-gcp.md
yanniszark pushed a commit to yanniszark/website that referenced this pull request Oct 23, 2019
)

* initial

* Document alternative deploy method of Kubeflow Pipelines

* adjust wording

* Adjust wording to give more context of choices user have

* Change kubectl apply -k to use github url, make it easier to understand where the manifest is

* Improvements based on Sarah's review

* Update KFP lite branding to KFP standalone

* Update to make the doc GCP specific

* Update gcp create cluster guide

* Rename deployment-alternatives doc to standalone deployment gcp

* Address review comments

* Update standalone-deployment-gcp.md
@Bobgy Bobgy deleted the kfp_lite branch November 8, 2019 06:22
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.

6 participants