diff --git a/docs/index.rst b/docs/index.rst index 4da4a0b..0bc369d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,38 +1,11 @@ -Introduction -============ - - | 'Small to medium-sized and classified as "Least Concern" by the IUCN.' - | `Wikipedia `_ [*]_ - - -.. [*] Before it was marked as "Endangered" in 2019 and the pun no longer works. - -Tapeti is a wrapper for the RabbitMQ .NET Client designed for long-running microservices. It's main goal is to minimize the amount of messaging code required, and instead focus on the higher-level flow. - -Tapeti is built using .NET Standard 2.0 and mostly tested using .NET 4.7. - -Key features ------------- - -* Consumers are declared using MVC-style controllers and are registered automatically based on annotations -* Publishing requires only the message class, no transport details such as exchange and routing key -* :doc:`flow` (stateful request - response handling with support for parallel requests) -* No inheritance required -* Graceful recovery in case of connection issues, and in contrast to most libraries not designed for services, during startup as well -* Extensible using middleware - - -What it is not --------------- -Tapeti is not a general purpose RabbitMQ client. Although some behaviour can be overridden by implementing various interfaces, it enforces it's style of messaging and assumes everyone on the bus speaks the same language. - -There is no support for TLS connections, nor are there any plans to support it. The author is of the opinion the message bus should be considered an internal, highly available, service and recommends self-hosted REST API's behind an SSL proxy for communicating over public interfaces. - +Tapeti documentation +==================== .. toctree:: - :hidden: + :maxdepth: 2 + :caption: Table of contents - index + introduction gettingstarted indepth dataannotations diff --git a/docs/introduction.rst b/docs/introduction.rst new file mode 100644 index 0000000..4a6eae1 --- /dev/null +++ b/docs/introduction.rst @@ -0,0 +1,29 @@ +Introduction +============ + + | 'Small to medium-sized and classified as "Least Concern" by the IUCN.' + | `Wikipedia `_ [*]_ + + +.. [*] Before it was marked as "Endangered" in 2019 and the pun no longer works. + +Tapeti is a wrapper for the RabbitMQ .NET Client designed for long-running microservices. It's main goal is to minimize the amount of messaging code required, and instead focus on the higher-level flow. + +Tapeti is built using .NET Standard 2.0 and mostly tested using .NET 4.7. + +Key features +------------ + +* Consumers are declared using MVC-style controllers and are registered automatically based on annotations +* Publishing requires only the message class, no transport details such as exchange and routing key +* :doc:`flow` (stateful request - response handling with support for parallel requests) +* No inheritance required +* Graceful recovery in case of connection issues, and in contrast to most libraries not designed for services, during startup as well +* Extensible using middleware + + +What it is not +-------------- +Tapeti is not a general purpose RabbitMQ client. Although some behaviour can be overridden by implementing various interfaces, it enforces it's style of messaging and assumes everyone on the bus speaks the same language. + +There is no support for TLS connections, nor are there any plans to support it. The author is of the opinion the message bus should be considered an internal, highly available, service and recommends self-hosted REST API's behind an SSL proxy for communicating over public interfaces. \ No newline at end of file