feature: add tags to proto files for quickstart (#232)

Author: rstento

samples/customer-registry-quickstart/src/main/proto/customer/customer_api.proto

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// tag::declarations[]
+
 syntax = "proto3";
 
 package customer.api;
@@ -21,6 +23,10 @@ option java_outer_classname = "CustomerApi";
 import "google/protobuf/empty.proto";
 import "akkaserverless/annotations.proto";
 
+// end::declarations[]
+
+// tag::messages[]
+
 message Customer {
   string customer_id = 1 [(akkaserverless.field).entity_key = true];
   string email = 2;
@@ -33,6 +39,10 @@ message Address {
   string city = 2;
 }
 
+// end::messages[]
+
+// tag::method-messages[]
+
 message GetCustomerRequest {
   string customer_id = 1 [(akkaserverless.field).entity_key = true];
 }
@@ -47,6 +57,11 @@ message ChangeAddressRequest {
   Address new_address = 2;
 }
 
+// end::method-messages[]
+
+
+// tag::service[]
+
 service CustomerService {
   option (akkaserverless.service) = {
     type: SERVICE_TYPE_ENTITY
@@ -61,3 +76,4 @@ service CustomerService {
 
   rpc GetCustomer(GetCustomerRequest) returns (Customer) {}
 }
+// end::service[]

samples/customer-registry-quickstart/src/main/proto/customer/customer_domain.proto

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// tag::declarations[]
+
 syntax = "proto3";
 
 package customer.domain;
@@ -20,12 +22,20 @@ option java_outer_classname = "CustomerDomain";
 
 import "akkaserverless/annotations.proto";
 
-option (akkaserverless.file).value_entity = { // <1>
+// end::declarations[]
+
+// tag::entity[]
+
+option (akkaserverless.file).value_entity = {
   name: "Customer"
   entity_type: "customers"
   state: "CustomerState"
 };
 
+// end::entity[]
+
+// tag::domain[]
+
 message CustomerState {
   string customer_id = 1;
   string email = 2;
@@ -37,3 +47,5 @@ message Address {
   string street = 1;
   string city = 2;
 }
+
+// end::domain[]

samples/customer-registry-quickstart/src/main/proto/customer/customer_view.proto

@@ -12,6 +12,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// tag::declarations[]
+
 syntax = "proto3";
 
 package customer.view;
@@ -21,6 +23,10 @@ option java_outer_classname = "CustomerViewModel";
 import "customer/customer_domain.proto";
 import "akkaserverless/annotations.proto";
 
+// end::declarations[]
+
+// tag::name[]
+
 service CustomerByName {
   option (akkaserverless.service) = {
     type: SERVICE_TYPE_VIEW
@@ -46,6 +52,10 @@ message ByNameRequest {
   string customer_name = 1;
 }
 
+// end::name[]
+
+
+// tag::email[]
 service CustomerByEmail {
   option (akkaserverless.service) = {
     type: SERVICE_TYPE_VIEW
@@ -70,3 +80,4 @@ service CustomerByEmail {
 message ByEmailRequest {
   string email = 1;
 }
+// end::email[]