docs(backend): improved backend README #11511

dandawg · 2025-01-13T22:51:26Z

Description of your changes:
This PR makes the following improvements to the backend/README.md file, which are broadly aimed at making the file more user friendly (easier to follow and clearer to understand):

Added an Overview section (intro) to make it more clear what the readme's purpose is.
Added a Prerequisites section to help people know up-front what they need. (In the future, it may be good to give even more details here, for example on versions). The go-licences pre-req is particularly important to building the docker image--without it users wait for the build to fail, then troubleshoot.
Organized content into major sections with more appropriate header levels.
The Code Style section was in the previously in the middle of the 'building and testing' commands--I moved it to it's own Contributing section at the end.
Fixed make all command to run from perspective the root (pipelines) directory (to be consistent with the other commands).
This also clarifies what is happening when some commands are run to help understanding / prevent misunderstandings.

Checklist:

You have signed off your commits
The title for your pull request (PR) should follow our title convention. Learn more about the pull request title convention used in this repository.

Signed-off-by: Daniel Dowler <[email protected]>

google-oss-prow · 2025-01-13T22:51:35Z

Hi @dandawg. 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. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

hbelmiro · 2025-01-14T15:20:00Z

/ok-to-test

github-actions · 2025-01-14T15:20:30Z

Approvals successfully granted for pending runs.

hbelmiro

Thank you @dandawg.
I left a few comments.

backend/README.md

Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>

dandawg · 2025-01-14T19:13:03Z

Thank you @dandawg. I left a few comments.

Great suggestions. I added in the changes @hbelmiro

hbelmiro

/lgtm
/ok-to-test

HumairAK · 2025-01-29T01:54:29Z

backend/README.md

+
+## Prerequisites
+Before you begin, ensure you have:
+- Go programming language installed


Suggested change

- Go programming language installed

- [Go installed](https://go.dev/doc/install)

I think typically you would say install "Go" and not "Go programming language" always nice to also link to the docs https://go.dev/doc/install

HumairAK · 2025-01-29T01:57:02Z

backend/README.md

-#### Deleting the Cluster
-
-Run the following to delete the cluster:
+Also, note that the config in the `make` command above sets the `ml-pipeline` `Deployment` (api server) to have 0 replicas. The intent is to replace it with a locally running API server for debugging and faster development. See the following steps to run the API server locally, and connect it to the KFP backend on your Kind cluster. Note that other backend components (for example, the persistence agent) may show errors until the API server is brought up and connected to the cluster.


Suggested change

Also, note that the config in the `make` command above sets the `ml-pipeline` `Deployment` (api server) to have 0 replicas. The intent is to replace it with a locally running API server for debugging and faster development. See the following steps to run the API server locally, and connect it to the KFP backend on your Kind cluster. Note that other backend components (for example, the persistence agent) may show errors until the API server is brought up and connected to the cluster.

> [!NOTE]

> The config in the `make` command above sets the `ml-pipeline` `Deployment` (api server) to have 0 replicas. The intent is to replace it with a locally running API server for debugging and faster development. See the following steps to run the API server locally, and connect it to the KFP backend on your Kind cluster. Note that other backend components (for example, the persistence agent) may show errors until the API server is brought up and connected to the cluster.

the above makes a prettier note rendering

HumairAK · 2025-01-29T01:58:41Z

left some comments but they are mostly nits, I'm happy to merge as is, if you'd like to follow up with the amendments, feel free!

/lgtm
/approve

google-oss-prow · 2025-01-29T01:58:47Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: HumairAK

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:

~~backend/OWNERS~~ [HumairAK]

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

Signed-off-by: Helber Belmiro <[email protected]> docs(backend): improved backend README (kubeflow#11511) * improved backend README Signed-off-by: Daniel Dowler <[email protected]> * Update backend/README.md Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]> * Update backend/README.md Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]> * Update backend/README.md Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]> * Update backend/README.md Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]> --------- Signed-off-by: Daniel Dowler <[email protected]> Co-authored-by: Helber Belmiro <[email protected]> fix(CI): Use the correct image registry for replacements in integration tests (kubeflow#11564) * Use the correct image registry for replacements in integration tests The image registry was changed to GitHub Container Registry in the 2.4 release. Signed-off-by: mprahl <[email protected]> * Print the pod logs when the pods fail to start in integration tests Signed-off-by: mprahl <[email protected]> * Fix the sample compilation in the API server container build Signed-off-by: mprahl <[email protected]> * Show the output when building the container images in CI Signed-off-by: mprahl <[email protected]> --------- Signed-off-by: mprahl <[email protected]> feat(api): Add SemaphoreKey and MutexName fields to proto (kubeflow#11384) Signed-off-by: ddalvi <[email protected]>

improved backend README

78e38bf

Signed-off-by: Daniel Dowler <[email protected]>

google-oss-prow bot added needs-ok-to-test size/M labels Jan 13, 2025

google-oss-prow bot requested review from gmfrasca and HumairAK January 13, 2025 22:52

google-oss-prow bot added ok-to-test and removed needs-ok-to-test labels Jan 14, 2025

hbelmiro reviewed Jan 14, 2025

View reviewed changes

backend/README.md Outdated Show resolved Hide resolved

backend/README.md Outdated Show resolved Hide resolved

backend/README.md Outdated Show resolved Hide resolved

backend/README.md Outdated Show resolved Hide resolved

dandawg and others added 4 commits January 14, 2025 12:10

Update backend/README.md

e68d764

Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>

Update backend/README.md

62aeb93

Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>

Update backend/README.md

81d167e

Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>

Update backend/README.md

6f578d7

Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>

hbelmiro reviewed Jan 14, 2025

View reviewed changes

google-oss-prow bot assigned hbelmiro Jan 14, 2025

google-oss-prow bot added the lgtm label Jan 14, 2025

HumairAK reviewed Jan 29, 2025

View reviewed changes

google-oss-prow bot assigned HumairAK Jan 29, 2025

google-oss-prow bot added the approved label Jan 29, 2025

google-oss-prow bot merged commit ce3850a into kubeflow:master Jan 29, 2025
32 checks passed

dandawg mentioned this pull request Jan 30, 2025

docs(backend): small formatting improvements #11570

Open

2 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(backend): improved backend README #11511

docs(backend): improved backend README #11511

dandawg commented Jan 13, 2025

google-oss-prow bot commented Jan 13, 2025

hbelmiro commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

hbelmiro left a comment

dandawg commented Jan 14, 2025

hbelmiro left a comment

HumairAK Jan 29, 2025

HumairAK Jan 29, 2025

HumairAK commented Jan 29, 2025

google-oss-prow bot commented Jan 29, 2025

	- Go programming language installed
	- [Go installed](https://go.dev/doc/install)

	Also, note that the config in the `make` command above sets the `ml-pipeline` `Deployment` (api server) to have 0 replicas. The intent is to replace it with a locally running API server for debugging and faster development. See the following steps to run the API server locally, and connect it to the KFP backend on your Kind cluster. Note that other backend components (for example, the persistence agent) may show errors until the API server is brought up and connected to the cluster.
	> [!NOTE]
	> The config in the `make` command above sets the `ml-pipeline` `Deployment` (api server) to have 0 replicas. The intent is to replace it with a locally running API server for debugging and faster development. See the following steps to run the API server locally, and connect it to the KFP backend on your Kind cluster. Note that other backend components (for example, the persistence agent) may show errors until the API server is brought up and connected to the cluster.

docs(backend): improved backend README #11511

docs(backend): improved backend README #11511

Conversation

dandawg commented Jan 13, 2025

google-oss-prow bot commented Jan 13, 2025

hbelmiro commented Jan 14, 2025

github-actions bot commented Jan 14, 2025

hbelmiro left a comment

Choose a reason for hiding this comment

dandawg commented Jan 14, 2025

hbelmiro left a comment

Choose a reason for hiding this comment

HumairAK Jan 29, 2025

Choose a reason for hiding this comment

HumairAK Jan 29, 2025

Choose a reason for hiding this comment

HumairAK commented Jan 29, 2025

google-oss-prow bot commented Jan 29, 2025