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

Add Makefile documentation #25

Merged
merged 2 commits into from
Aug 15, 2023
Merged

Add Makefile documentation #25

merged 2 commits into from
Aug 15, 2023

Conversation

ddelange
Copy link
Contributor

Motivation

kserve/modelmesh-runtime-adapter#38 (comment)

Modifications

Add help texts

Result

all                       - Alias for `build`
build                     - Build runtime docker image
develop                   - Build develop docker image and run an interactive shell in the develop envionment
fmt                       - Run formatting
help                      - Print Makefile documentation
run                       - Build develop docker image and run a make command in the develop envionment (e.g. `make run fmt` will execute `make fmt` within the docker container)
test                      - Run tests

@ddelange
Copy link
Contributor Author

cc @ckadner this is the last one I think

@ckadner ckadner self-requested a review May 19, 2023 17:24
@ckadner ckadner self-assigned this May 19, 2023
@ckadner
Copy link
Member

ckadner commented May 19, 2023

cc @ckadner this is the last one I think

Thanks @ddelange I will add my review comments shortly.

Copy link
Member

@ckadner ckadner left a comment

Choose a reason for hiding this comment

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

This is great! Thanks @ddelange

/lgtm

@ckadner ckadner merged commit 079569e into kserve:main Aug 15, 2023
3 checks passed
@ckadner ckadner added this to the v0.11.1 milestone Oct 2, 2023
@ckadner ckadner assigned ddelange and unassigned ckadner Oct 2, 2023
@ckadner ckadner added the documentation Improvements or additions to documentation label Oct 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants