kubeflow / website

Kubeflow's public website
Creative Commons Attribution 4.0 International
145 stars 752 forks source link

fix: Updated description for pipeline_version_id in Runs and Recurring Runs API docs #3694

Closed amadhusu closed 3 months ago

amadhusu commented 4 months ago

This doc is generated via the tool (https://github.com/kubeflow/pipelines/tree/master/backend/api#updating-of-api-reference-documentation) after the changes #10581 and #10591 were merged.

This will resolve #10451

Description The updated API docs from the tool should reflect the Deprecated status of pipeline_version_id in Runs and Recurring Runs.

google-cla[bot] commented 4 months ago

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

google-oss-prow[bot] commented 4 months ago

Hi @amadhusu. Thanks for your PR.

I'm waiting for a kubeflow member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
hbelmiro commented 4 months ago

/ok-to-test

diegolovison commented 3 months ago

/lgtm

rimolive commented 3 months ago

@Tomcli @chensun As the Pipelines WG approvers, can you confirm if manual changes to these pages look good? Or there is a tool that generates this content?

amadhusu commented 3 months ago

@Tomcli @chensun reiterating @rimolive's question.

chensun commented 3 months ago

This file is generated via a tool. Can you follow this instruction to check if it indeed needs update? https://github.com/kubeflow/pipelines/tree/master/backend/api#updating-of-api-reference-documentation

amadhusu commented 3 months ago

This file is generated via a tool. Can you follow this instruction to check if it indeed needs update? https://github.com/kubeflow/pipelines/tree/master/backend/api#updating-of-api-reference-documentation

@chensun So the tool insisted this API doc doesn't need an update. After digging into why, I believe it is due to this -> https://github.com/kubeflow/pipelines/blob/master/backend/api/v2beta1/run.proto#L165 and https://github.com/kubeflow/pipelines/blob/master/backend/api/v2beta1/recurring_run.proto#L89 .

Screenshot from 2024-03-14 16-14-50

Any reason to keep this deprecated field when we refer the same thing underneath pipeline_version_reference or can we do away with the deprecated field?

amadhusu commented 3 months ago

@chensun @Tomcli After updating kubeflow/pipelines w.r.t. #10581 and #10591. This API doc is generated from the tool and now contains the relevant information to resolve this issue (Thanks for pointing to the tool). Can you guys review the same?

google-oss-prow[bot] commented 3 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: amadhusu, chensun, diegolovison, Tomcli

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/components/pipelines/OWNERS](https://github.com/kubeflow/website/blob/master/content/en/docs/components/pipelines/OWNERS)~~ [chensun] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment