diff --git a/doc/source/index.rst b/doc/source/index.rst index 40f8ad9..8ceaa61 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,6 +1,9 @@ Log management service (Venus) ============================== +What is Venus? +--------------- + Venus is an OpenStack project that aims to provide a one-stop solution to log collection, cleaning, indexing, analysis, alarm, visualization, report generation and other needs, which involves helping operator or @@ -11,11 +14,13 @@ Which can include OpenStack logs, operating system logs, cloud platform service logs, and virtualized application related logs. -Overview --------- +Using the Venus API +~~~~~~~~~~~~~~~~~~~~ -.. toctree:: - :maxdepth: 1 +All features of Venus are exposed via a REST API. The following resources +can help you get started consuming the API directly. + +* `Venus API `_ Documentation for Developers