-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
docs(backend): improved backend README #11511
base: master
Are you sure you want to change the base?
Conversation
Signed-off-by: Daniel Dowler <[email protected]>
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 Once the patch is verified, the new status will be reflected by the 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. |
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/ok-to-test |
Approvals successfully granted for pending runs. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you @dandawg.
I left a few comments.
Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>
Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>
Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>
Co-authored-by: Helber Belmiro <[email protected]> Signed-off-by: Daniel Dowler <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
/ok-to-test
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):go-licences
pre-req is particularly important to building the docker image--without it users wait for the build to fail, then troubleshoot.Code Style
section was in the previously in the middle of the 'building and testing' commands--I moved it to it's ownContributing
section at the end.make all
command to run from perspective the root (pipelines
) directory (to be consistent with the other commands).Checklist: