vladan/webstat-collector
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update documentation, include readme in index

Browse source
This commit is contained in:
Vladan Popovic 2020-09-07 13:31:19 +02:00
parent d4de6e0b2d
commit 5c42aaa023
6 changed files with 16 additions and 69 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
docs/source/.index.rst.swp Normal file
View file

Binary file not shown.

1
docs/source/architecture.rst
View file

@ -1,3 +1,4 @@
====================
Overall architecture
====================

3
docs/source/configuration.rst
View file

@ -1,3 +1,4 @@
====================
Running the services
====================
@ -20,6 +21,8 @@ Both of them need a configuration file to start, e.g.::
Configuration
-------------
.. highlight:: yaml
Both cli scripts use the same config file to simplify deployment. You only set
it up once and supply it to the scripts on their locations.

1
docs/source/environment.rst
View file

@ -1,3 +1,4 @@
==================
Environment config
==================

10
docs/source/index.rst
View file

@ -3,18 +3,14 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
============================
chweb - Check websites state
============================
CHWEB is a website checking tool.
ATM in its very early stages meant to demo
`aiven <https://aiven.io>`_'s platform, using their `kafka
<https://aiven.io/kafka>`_ and `postgresql <https://aiven.io/postgresql>`_
services.
.. include:: ../../README.rst
Features
--------
========
* Easy and intuitive YAML configuration.
* Command line executables for the checker and the consumer/psql writer: