From 502df0ffeee605d1daeb73986e9c01908b3d1288 Mon Sep 17 00:00:00 2001 From: Mark van Renswoude Date: Tue, 20 Aug 2019 12:17:48 +0200 Subject: [PATCH] Reorganized the documentation so that the introduction is the landing page. Learned that the Tapeti is now classified as endangered. No implications for this library I hope! --- docs/index.rst | 37 ++++++++++++++++++++++++++++++++----- docs/introduction.rst | 26 -------------------------- 2 files changed, 32 insertions(+), 31 deletions(-) delete mode 100644 docs/introduction.rst diff --git a/docs/index.rst b/docs/index.rst index ae44468..4da4a0b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,11 +1,38 @@ -Tapeti documentation -==================== +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. + .. toctree:: - :maxdepth: 2 - :caption: Contents: + :hidden: - introduction + index gettingstarted indepth dataannotations diff --git a/docs/introduction.rst b/docs/introduction.rst deleted file mode 100644 index a36c41d..0000000 --- a/docs/introduction.rst +++ /dev/null @@ -1,26 +0,0 @@ -Introduction -============ - - | 'Small to medium-sized and classified as "Least Concern" by the IUCN.' - | `Wikipedia `_ - -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