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

The kfp setup.md file needs to tell you to run make setup command in the kind directory. #252

Closed
wants to merge 11 commits into from

Conversation

deanwampler
Copy link
Contributor

Note: This PR is based off my previous deanw-pr. The only new change compared to that PR is to one file: kfp/doc/setup.md.

Why are these changes needed?

Without telling you to run the make setup command in the kind directory, you'll guess you should do it in the kfp directory, but the target isn't defined there.

Related issue number (if any).

N/A

data-processing-lib/ray/pyproject.toml Outdated Show resolved Hide resolved
data-processing-lib/python/pyproject.toml Outdated Show resolved Hide resolved
kfp/doc/setup.md Outdated
@@ -66,10 +66,11 @@ choose your OS system, and process according to "(Optional) Install the MinIO Cl

## Installation steps <a name = "installation"></a>

You can create a Kind cluster with all required software installed using the following command:
You can create a Kind cluster with all required software installed using the following command, run in the `kind` directory under the repo root:
Copy link
Member

Choose a reason for hiding this comment

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

Hi @deanwampler , sorry maybe it is my English, but the sentence is not clear to me especially that the first command is cd kind.
Will it be better:
You can create a Kind cluster with all required software installed using the following command:

make -C kind setup

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe I missed that. Sorry.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pushing an update...

@deanwampler
Copy link
Contributor Author

I think the only "meaningful" difference left is the suggestion for an all target. If you don't want it, go ahead and close this PR. That's fine with me.

@@ -27,6 +28,8 @@ include .make.defaults
# Global rules that are generally to be implemented in the sub-directories and can
# be overridden there (the double colon on the rule makes the overridable).

all: clean test build
Copy link
Member

Choose a reason for hiding this comment

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

I don't know if we're ready for this, in particular build is ill-defined.

Copy link
Member

Choose a reason for hiding this comment

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

@daw3rd and @roytman If making a make all target is not feasible, please close this PR, but before doing that, Dean has found a typo in the setup.md file: deside => decide

Copy link
Member

Choose a reason for hiding this comment

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

The typo is fixed by #333.

The kind directory is going to be refactored in a separate PR, and the README file in the root directory will be updated accordingly.

@roytman
Copy link
Member

roytman commented Jun 25, 2024

@deanwampler , thank you for your review and the PR. We will update the instructions on how to install a Kind cluster.
In addition, we are in contact with the KubeRay community about execution KubeRay on Mac with M1 CPU.
Meantime, I'm closing this PR.

@roytman roytman closed this Jun 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants