Skip to content

Commit

Permalink
docs(backend): small formatting improvements (#11570)
Browse files Browse the repository at this point in the history
* rebase resolution

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

* removing go-licenses install instruction

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

---------

Signed-off-by: Daniel Dowler <[email protected]>
  • Loading branch information
dandawg authored Feb 12, 2025
1 parent dcaf5a4 commit ba22703
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This README will help you set up your coding environment in order to build and r

## Prerequisites
Before you begin, ensure you have:
- Go programming language installed
- [Go installed](https://go.dev/doc/install)
- Docker or Podman installed (for building container images)

Note that you may need to restart your shell after installing these resources in order for the changes to take effect.
Expand Down Expand Up @@ -97,7 +97,8 @@ make -C backend dev-kind-cluster
This may take several minutes since there are many pods. Note that many pods will be in "CrashLoopBackOff" status until
all the pods have started.

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.
#### Launching the API Server With VSCode

Expand Down

0 comments on commit ba22703

Please sign in to comment.