diff options
| author |   Lee, Tian (tl5884) <tianl@amdocs.com> | 2018-02-05 10:17:48 +0000 |
|---|---|---|
| committer | Lee, Tian (tl5884) <tianl@amdocs.com> | 2018-02-05 10:17:48 +0000 |
| commit | 0556bc61f7cb201974cbcb66fa9d82b8d27c50bc (patch) | |
| tree | 87650b00af8f30a4bafbe52681d830a7b621b058 /docs/index.rst | |
| parent | 4150ee34ae503c83734aca7e62ca9911b354c881 (diff) | |
Initial draft of Event Client documentation
In RST format
Change-Id: I52ecc7523aa0af3735d8417cb5edca1460252f2f
Issue-ID: AAI-700
Signed-off-by: Lee, Tian (tl5884) <tianl@amdocs.com>
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..b16d6b3 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. + +Event Client Documentation Repository +---------------------------- +The Event Client project is a common API library that can be used by various microservices to publish/consume events to/from supported event messaging platforms. + +Supported event messaging platforms: + +- DMaaP: This is the bespoke messaging platform released with ONAP. It is based ontop of Kafka. +- Kafka: This is the vanilla Apache Kafka messaging platform. It exposes additional API functionality such as replay and committing offsets. + +.. toctree:: + :maxdepth: 2 + + release-notes.rst + Event Client API Documentation/EventClientAPI_Beijing.rst + |