Template

Pre-conditions

Expected knowledge and tools to run this example. Only nats-server and nats are implied.

E.g. "Uses scp for configuring authentication"

Goal

Briefly describe what the overarching use case is and which configurations and features are being demonstrated.

Concepts and Patterns

Briefly explain architectural ideas and design patterns used.

Step by step example

May be broken into sections

Do's and Dont's

Avoid linking to external information in the step-by-step guide.
Explain or refer to a concept front up.
In the step-by-step section, explain the parameters and options used, nothing else.
Provide every single command and configuration.
Do not introduce a new tool in the step-by-step guide
Concrete parameters - there should be no need to infer anything
Use concrete names for entities - e.g. from payment processing or retail order management