docs: Add developer instructions to README.md

[ckadner]

Motivation

It can be challenging to figure out how to get a development environment setup especially for folks who have not worked with Maven before.

Modifications

Adding some information of development workflow and project setup for working with an IDE.

Result

Hopefully a less frustrating on-boarding experience.

/cc @rafvasq

[rafvasq]

@ckadner Do you think we could make a docs directory and start it with this developer-guide.md? It'd probably be beneficial to start documenting more aspects of this framework as we continue to develop here.

[ckadner]

@ckadner Do you think we could make a docs directory and start it with this developer-guide.md? It'd probably be beneficial to start documenting more aspects of this framework as we continue to develop here.

I think the idea was to keep all (or most) of the documentation in one place inside the modelmesh-serving repo's docs folder.

But I do agree it makes sense to have a separate document for development related information -- as opposed to the "consumer-oriented" general info in the main README.md.

[rafvasq]

Thanks @ckadner, it's already proved helpful for me and acts as a great starter doc that we can amend over time.

[ScrapCodes]

Hi @ckadner ! the guide has been useful to me as is ( i have left comments for your consideration only), however, I have not been successful in getting the newly built and pushed image to be updated to existing modelmesh-controller deployment.

[rafvasq]

@ckadner is there anything you'd like to change here based on @ScrapCodes comments/any additions since you opened this? Or can we merge this as a good starting point for a developer doc?

[ckadner]

@ckadner is there anything you'd like to change here based on @ScrapCodes comments/any additions since you opened this? Or can we merge this as a good starting point for a developer doc?

Hi @rafvasq -- I will take another pass and see how I can best address the review comments

[rafvasq]

Just a small nit. Thanks @ckadner.

[ckadner]

@rafvasq -- I pushed a last set of updates. Thanks for your review!

[rafvasq]

/lgtm

[kserve-oss-bot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: ckadner, rafvasq

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:

• OWNERS [ckadner,rafvasq]

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