Skip to content

Commit

Permalink
Add a README for docs/examples
Browse files Browse the repository at this point in the history
  • Loading branch information
ChunyiLyu committed Jun 11, 2021
1 parent 9661191 commit 695068b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/examples/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Messaging Topology Operator examples

This section contains examples on how to create RabbitMQ topology objects using the Messaging Topology Operator.

### Usage

These examples are intended to showcase common use cases for the Messaging Topology Operator. Some examples can be used directly, but
properties such as resources names and namespaces need to be edited for your own environment. For a more comprehensive guide on how
to use the Operator, see the [Using Messaging Topology Operator](https://www.rabbitmq.com/kubernetes/operator/using-topology-operator.html)
guide on `rabbitmq.com` and the Operator [API reference](https://github.com/rabbitmq/messaging-topology-operator/blob/main/docs/api/rabbitmq.com.ref.asciidoc).

0 comments on commit 695068b

Please sign in to comment.