Add opening tutorial and consumer tutorial. #70
Conversation
Alex Recommends ReportAlex recommends the following language changes, but Alex is a regular expression based algorithm, so take them with a grain of salt. ✨ 🚀 ✨ Nothing to Report ✨ 🚀 ✨ |
docs/tutorials/provider/README.md
Outdated
| @@ -65,7 +65,8 @@ You have defined your digital twin provider interface. | |||
|
|
|||
| The following lists out the flow for implementing the operations of a digital twin interface in the programming language of your choice: | |||
|
|
|||
| 1. Choose Your Programming Language: Since operations can be defined in a protobuf file, you can select any programming language that supports protobufs. This includes languages like Rust, Python, Java, C++, Go, etc. However, operations do not need to be defined in a protobuf file to be programming language agnostic. For instance, if you have a subscribe operation you may want to use [MQTT](https://mqtt.org/) for publishing to digital twin consumers that have subscribed to your digital twin provider. Please see the [Managed Subscribe Sample](https://github.com/eclipse-ibeji/ibeji/tree/main/samples/managed_subscribe) and [Property Sample](../../../samples/property/provider/src/main.rs) for Rust examples of a digital twin provider using MQTT. | |||
| 1. Choose a programming language that supports gRPC. gRPC is required to communicate with the In-Vehicle Digital Twin Service. This will be described further in [2. Register Digital Twin Provider with the In-Vehicle Digital Twin Service](#2-register-digital-twin-provider-with-the-in-vehicle-digital-twin-service). This includes languages like Rust, Python, Java, C++, Go, etc. | |||
| >Note: Operations do not need to be defined in a protobuf file to be programming language agnostic. If you have a subscribe operation you may want to use [MQTT](https://mqtt.org/) for publishing to digital twin consumers that have subscribed to your digital twin provider. Please see the [Managed Subscribe Sample](../../../samples/managed_subscribe/README.md) and [Property Sample](../../../samples/property/provider/src/main.rs) for Rust examples of a digital twin provider using MQTT. | |||
There was a problem hiding this comment.
I think that you really want to emphasize that operations can be protocol agnostic here. You could say something like:
Operations can be performed by various protocols. Some protocols will require that the operation's interface contract is specified, e.g. gRPC where the operation must be specified in a protobuf file.
There was a problem hiding this comment.
I changed the first sentence to Operations can be performed by various protocols. Some protocols require that the operation's interface contract is specified. For example in gRPC, the operation must be specified in a protobuf file. Operations are programming language and protocol agnostic.
|
The markdown-link-check states that https://aka.ms/opensource/security/pgpkey is a dead link. This link is valid. |
The following are added in this PR:
Updates to the digital twin provider tutorial were included in this PR.