docs: add new quickstart for customer registry in javascript #379
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
Documentation
pvlugter
commented
Jun 29, 2022
Comment on lines
+4
to
+5
| # test quickstarts without lock file | ||
| /package-lock.json |
There was a problem hiding this comment.
Not committing the package lock file for this sample, so that testing is similar to user download.
Comment on lines
+70
to
+71
| rpc ChangeName(ChangeNameRequest) returns (google.protobuf.Empty) {} | ||
| rpc ChangeAddress(ChangeAddressRequest) returns (google.protobuf.Empty) {} |
There was a problem hiding this comment.
This has the name and address changing methods, like for the Java/Scala versions, but these are not included in the quickstart guide in the docs.
pvlugter
force-pushed
the
js-customer-registry-quickstart
branch
from
e92436d
to
1a6d02f
Compare
pvlugter
commented
Jun 29, 2022
Comment on lines
+56
to
+62
| option (kalix.codegen) = { | ||
| value_entity: { | ||
| name: "customer.domain.Customer" | ||
| entity_type: "customers" | ||
| state: "customer.domain.CustomerState" | ||
| } | ||
| }; |
There was a problem hiding this comment.
Also using the new codegen annotation now.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current customer registry sample includes more than needed for the quickstart (has both value entity and event sourced entity versions) and is not set up for being a usable and runnable download. The quickstart docs for this sample (currently in the main docs) are outdated, use line numbers for code samples, and don't use the codegen.
Update things in line with the customer registry quickstarts for JVM SDKs.
Create a new version of the customer registry sample for the quickstart, based on the template and using codegen, with tests, and its own quickstart-friendly README. The quickstart bundle is tested in CI. This is a new customer registry sample, with the old one unchanged (still referenced by the main docs), and the old sample can be updated later (like in the JVM SDKs).
Add a new quickstart guide to the docs here, updated to use the basic template and codegen. The one in the main docs can be replaced once this is published.
Once reviewed, a TypeScript version can be added. The other quickstart (shopping cart) is being updated in https://github.com/lightbend/kalix-docs/pull/1402, which can also be moved here and its quickstart download updated.