diff --git a/docs/src/modules/javascript/pages/access-control.adoc b/docs/src/modules/javascript/pages/access-control.adoc index 92e7cfa0..6590ec2b 100644 --- a/docs/src/modules/javascript/pages/access-control.adoc +++ b/docs/src/modules/javascript/pages/access-control.adoc @@ -8,7 +8,7 @@ include::ROOT:partial$grpc/using-acls.adoc[] If no ACLs are defined at all in a Kalix service, Kalix will allow requests from both other services and the internet to all components of the Kalix service. -The Kalix quickstarts include a less permissive ACL for the entire service, to not accidentally make services available to the public internet, just like the one described in the next section. +The Kalix samples include a less permissive ACL for the entire service, to not accidentally make services available to the public internet, just like the one described in the next section. == Defining an ACL for the entire Kalix Service @@ -22,7 +22,7 @@ include::example$js-doc-snippets/proto/com/example/kalix_policy.proto[tag=defaul <1> Import the needed Kalix annotations from `kalix/annotations.proto` <2> Allow access from all other services, but not the public internet -This is the default ACL included in the quickstarts and project templates, it allows calls from any other Kalix service deployed in the same project, but denies access from the internet. +This is the default ACL included in the samples and project templates. It allows calls from any other Kalix service deployed in the same project, but denies access from the internet. == Inspecting the principal inside a service diff --git a/docs/src/modules/javascript/pages/index.adoc b/docs/src/modules/javascript/pages/index.adoc index 95c552c8..ab745e63 100644 --- a/docs/src/modules/javascript/pages/index.adoc +++ b/docs/src/modules/javascript/pages/index.adoc @@ -12,7 +12,7 @@ Your development project needs to include the Kalix JavaScript SDK and logic to To simplify this process, the JavaScript xref:kickstart.adoc[code generation tool] produces a pre-built project with descriptors and implementations. -If you prefer to begin by exploring a fully implemented Kalix service, you can try one of our comprehensive https://www.kalix.io/developer/experience/typescript/[use cases] or a https://docs.kalix.io/quickstart/index.html#_typescriptprotobuf[Quickstart application]. +If you prefer to begin by exploring a fully implemented Kalix service, you can try one of our comprehensive https://www.kalix.io/developer/experience/typescript/[use cases] or a https://docs.kalix.io/samples/index.html[sample application]. == Prerequisites diff --git a/docs/src/modules/javascript/pages/quickstart/cr-value-entity-javascript.adoc b/docs/src/modules/javascript/pages/quickstart/cr-value-entity-javascript.adoc index 2c5891ef..dd480bca 100644 --- a/docs/src/modules/javascript/pages/quickstart/cr-value-entity-javascript.adoc +++ b/docs/src/modules/javascript/pages/quickstart/cr-value-entity-javascript.adoc @@ -1,4 +1,4 @@ -= Quickstart: Customer Registry in JavaScript += Customer Registry in JavaScript include::ROOT:partial$include.adoc[] include::javascript:partial$attributes.adoc[] @@ -8,8 +8,8 @@ Learn how to create a customer registry in JavaScript, package it into a contain == Before you begin * If you're new to Kalix, https://console.kalix.io[create an account{tab-icon}, window="new"] so you can try it out for free. -* You'll also need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. -* For this quickstart, you'll also need +* You'll need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. +* You'll also need ** https://docs.docker.com/engine/install[Docker {minimum_docker_version} or higher, window="new"] ** https://nodejs.org/en/download/[Node.js {minimum_node_version}, window="new"] ** https://github.com/fullstorydev/grpcurl#installation[`grpcurl`, window="new"] @@ -104,7 +104,7 @@ include::javascript:example$js-customer-registry-quickstart/proto/customer_api.p == Define the domain model -The `customer_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#value_entity[Value Entity, window="new"] in this quickstart is a Key/Value store that stores only the latest updates. +The `customer_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#value_entity[Value Entity, window="new"] in this sample is a Key/Value store that stores only the latest updates. . Create a `customer_domain.proto` file and save it in the `proto` directory. @@ -242,4 +242,4 @@ kalix service expose customer-registry == Next steps * You can learn more about xref:javascript:value-entity.adoc[Value Entities]. -* Do another xref:javascript:quickstart/sc-eventsourced-entity-javascript.adoc[Quickstart] to learn about Event Sourcing and xref:javascript:eventsourced.adoc[Event Sourced Entities]. +* Look at another xref:javascript:quickstart/sc-eventsourced-entity-javascript.adoc[sample] to learn about Event Sourcing and xref:javascript:eventsourced.adoc[Event Sourced Entities]. diff --git a/docs/src/modules/javascript/pages/quickstart/cr-value-entity-typescript.adoc b/docs/src/modules/javascript/pages/quickstart/cr-value-entity-typescript.adoc index 217a5b14..94766719 100644 --- a/docs/src/modules/javascript/pages/quickstart/cr-value-entity-typescript.adoc +++ b/docs/src/modules/javascript/pages/quickstart/cr-value-entity-typescript.adoc @@ -1,4 +1,4 @@ -= Quickstart: Customer Registry in TypeScript += Customer Registry in TypeScript include::ROOT:partial$include.adoc[] include::javascript:partial$attributes.adoc[] @@ -8,8 +8,8 @@ Learn how to create a customer registry in TypeScript, package it into a contain == Before you begin * If you're new to Kalix, https://console.kalix.io[create an account{tab-icon}, window="new"] so you can try it out for free. -* You'll also need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. -* For this quickstart, you'll also need +* You'll need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. +* You'll also need ** https://docs.docker.com/engine/install[Docker {minimum_docker_version} or higher, window="new"] ** https://nodejs.org/en/download/[Node.js {minimum_node_version}, window="new"] ** https://github.com/fullstorydev/grpcurl#installation[`grpcurl`, window="new"] @@ -104,7 +104,7 @@ include::javascript:example$ts-customer-registry-quickstart/proto/customer_api.p == Define the domain model -The `customer_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#value_entity[Value Entity, window="new"] in this quickstart is a Key/Value store that stores only the latest updates. +The `customer_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#value_entity[Value Entity, window="new"] in this sample is a Key/Value store that stores only the latest updates. . Create a `customer_domain.proto` file and save it in the `proto` directory. @@ -242,4 +242,4 @@ kalix service expose customer-registry == Next steps * You can learn more about xref:javascript:value-entity.adoc[Value Entities]. -* Do another xref:javascript:quickstart/sc-eventsourced-entity-typescript.adoc[Quickstart] to learn about Event Sourcing and xref:javascript:eventsourced.adoc[Event Sourced Entities]. +* Look at another xref:javascript:quickstart/sc-eventsourced-entity-typescript.adoc[sample] to learn about Event Sourcing and xref:javascript:eventsourced.adoc[Event Sourced Entities]. diff --git a/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-javascript.adoc b/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-javascript.adoc index dc673869..8f1aeac6 100644 --- a/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-javascript.adoc +++ b/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-javascript.adoc @@ -1,4 +1,4 @@ -= Quickstart: Shopping Cart in JavaScript += Shopping Cart in JavaScript include::ROOT:partial$include.adoc[] include::javascript:partial$attributes.adoc[] @@ -8,8 +8,8 @@ Learn how to create a shopping cart in JavaScript, package it into a container, == Before you begin * If you're new to Kalix, https://console.kalix.io[create an account{tab-icon}, window="new"] so you can try it out for free. -* You'll also need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. -* For this quickstart, you'll also need +* You'll need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. +* You'll also need ** https://docs.docker.com/engine/install[Docker {minimum_docker_version} or higher, window="new"] ** https://nodejs.org/en/download/[Node.js {minimum_node_version}, window="new"] ** https://github.com/fullstorydev/grpcurl#installation[`grpcurl`, window="new"] @@ -104,7 +104,7 @@ include::javascript:example$js-shopping-cart-quickstart/proto/shopping_cart_api. == Define the domain model -The `shopping_cart_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#event_sourced_entity[Event Sourced Entity, window="new"] in this Quickstart keeps all events sent for a specific shopping cart in a journal. +The `shopping_cart_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#event_sourced_entity[Event Sourced Entity, window="new"] in this sample keeps all events sent for a specific shopping cart in a journal. . Create a `shopping_cart_domain.proto` file and save it in the `proto` directory. @@ -124,7 +124,7 @@ include::javascript:example$js-shopping-cart-quickstart/proto/shopping_cart_doma include::javascript:example$js-shopping-cart-quickstart/proto/shopping_cart_domain.proto[tag=state] ---- -. Event Sourced entities work based on events. Add the events that can occur in this Quickstart: +. Event Sourced entities work based on events. Add the events that can occur in this sample: + [source, proto, indent=0] ---- diff --git a/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-typescript.adoc b/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-typescript.adoc index ab5f55a6..fff5894d 100644 --- a/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-typescript.adoc +++ b/docs/src/modules/javascript/pages/quickstart/sc-eventsourced-entity-typescript.adoc @@ -1,4 +1,4 @@ -= Quickstart: Shopping Cart in TypeScript += Shopping Cart in TypeScript include::ROOT:partial$include.adoc[] include::javascript:partial$attributes.adoc[] @@ -8,8 +8,8 @@ Learn how to create a shopping cart in TypeScript, package it into a container, == Before you begin * If you're new to Kalix, https://console.kalix.io[create an account{tab-icon}, window="new"] so you can try it out for free. -* You'll also need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. -* For this quickstart, you'll also need +* You'll need to install the https://docs.kalix.io/kalix/install-kalix.html[Kalix CLI, window="new-doc"] to deploy from a terminal window. +* You'll also need ** https://docs.docker.com/engine/install[Docker {minimum_docker_version} or higher, window="new"] ** https://nodejs.org/en/download/[Node.js {minimum_node_version}, window="new"] ** https://github.com/fullstorydev/grpcurl#installation[`grpcurl`, window="new"] @@ -104,7 +104,7 @@ include::javascript:example$ts-shopping-cart-quickstart/proto/shopping_cart_api. == Define the domain model -The `shopping_cart_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#event_sourced_entity[Event Sourced Entity, window="new"] in this Quickstart keeps all events sent for a specific shopping cart in a journal. +The `shopping_cart_domain.proto` contains all the internal data objects (https://docs.kalix.io/reference/glossary.html#entity[Entities, window="new"]). The https://docs.kalix.io/reference/glossary.html#event_sourced_entity[Event Sourced Entity, window="new"] in this sample keeps all events sent for a specific shopping cart in a journal. . Create a `shopping_cart_domain.proto` file and save it in the `proto` directory. @@ -124,7 +124,7 @@ include::javascript:example$ts-shopping-cart-quickstart/proto/shopping_cart_doma include::javascript:example$ts-shopping-cart-quickstart/proto/shopping_cart_domain.proto[tag=state] ---- -. Event Sourced entities work based on events. Add the events that can occur in this Quickstart: +. Event Sourced entities work based on events. Add the events that can occur in this sample: + [source, proto, indent=0] ---- diff --git a/samples/js/js-customer-registry-quickstart/README.md b/samples/js/js-customer-registry-quickstart/README.md index af6c1c8f..a9e7e0d8 100644 --- a/samples/js/js-customer-registry-quickstart/README.md +++ b/samples/js/js-customer-registry-quickstart/README.md @@ -1,4 +1,4 @@ -# Quickstart project: Customer Registry +# Customer Registry ## Designing diff --git a/samples/js/js-shopping-cart-quickstart/README.md b/samples/js/js-shopping-cart-quickstart/README.md index d8de2c7a..cef2aeb8 100644 --- a/samples/js/js-shopping-cart-quickstart/README.md +++ b/samples/js/js-shopping-cart-quickstart/README.md @@ -1,4 +1,4 @@ -# Quickstart project: Shopping Cart +# Shopping Cart ## Designing diff --git a/samples/ts/ts-customer-registry-quickstart/README.md b/samples/ts/ts-customer-registry-quickstart/README.md index 35c9de10..94227fbd 100644 --- a/samples/ts/ts-customer-registry-quickstart/README.md +++ b/samples/ts/ts-customer-registry-quickstart/README.md @@ -1,4 +1,4 @@ -# Quickstart project: Customer Registry +# Customer Registry ## Designing diff --git a/samples/ts/ts-shopping-cart-quickstart/README.md b/samples/ts/ts-shopping-cart-quickstart/README.md index c3244bec..008e8496 100644 --- a/samples/ts/ts-shopping-cart-quickstart/README.md +++ b/samples/ts/ts-shopping-cart-quickstart/README.md @@ -1,4 +1,4 @@ -# Quickstart project: Shopping Cart +# Shopping Cart ## Designing