kalix-jvm-sdk icon indicating copy to clipboard operation
kalix-jvm-sdk copied to clipboard

Java/Spring Docs: Recommendation section on organizing your app

Open efgpinto opened this issue 2 years ago • 2 comments

While working on lightbend/kalix#7720 , I noticed it depends on the "Writing gRPC descriptors" where the contracts for implementing a value entity shopping cart are introduced and explained for the java counterpart. Obviously, for the spring-sdk such page does not make much sense (not entitled like that at least).

However, I think we could use that page (with an adequate title) to explain how do we expect the application to be organized (explaining the use of a domain package / records to hold the domain transformation logic, the entity as a wrapper of the domain, etc). I think it's a nice section to have before you dive in the details of implementing the different types of entities and it would allow us to have parity with the other sdk by using the value entity shopping cart as an example similar. Thoughts?

Screenshot 2022-11-04 at 16 44 50

I don't have a title to propose yet though..

efgpinto avatar Nov 04 '22 16:11 efgpinto

I think this is a great idea.

Suggestion: don't worry about the title now. Write the doc first and then we can find an appropriate title later.

beritou avatar Nov 04 '22 18:11 beritou

Was discussing this with @franciscolopezsancho , @octonato and @aludwiko .

We've agreed that this page will be useful to explain some concepts although we also agreed to break the dependency between https://github.com/lightbend/kalix/issues/7720 and this section. Contents for this page is still up for refinement.

efgpinto avatar Nov 08 '22 09:11 efgpinto