Browse Source

Updating index & theme for RTD.
Adding RTD link to README

cmacrae 10 years ago
parent
commit
afaea32a65
3 changed files with 5 additions and 5 deletions
  1. 2 1
      README.md
  2. 2 4
      docs/index.md
  3. 1 0
      mkdocs.yml

+ 2 - 1
README.md

@@ -7,7 +7,8 @@ This role deploys a full [Sensu](https://sensuapp.org) stack, a modern, open sou
 - Automatic generation and dynamic deployment of SSL certs for secure communication between your clients and servers
 - Highly configurable
 
-_Note:_ _Further documentation on features is coming_
+## Documentation
+Head over to [Read the Docs](http://ansible-sensu.rtfd.org/) for a comprehensive overview of this role and its powerful features.
 
 ## Supported Platforms
 This role has been written with [SmartOS](https://smartos.org) in mind, to be deployed to [zones](https://wiki.smartos.org/display/DOC/Zones)

+ 2 - 4
docs/index.md

@@ -1,5 +1,5 @@
-# Sensu
-This role deploys a full [Sensu](https://sensuapp.org) stack, a modern, open source monitoring framework.
+# Ansible Sensu
+An [Ansible](https://ansible.com) role that deploys a full [Sensu](https://sensuapp.org) stack, a modern, open source monitoring framework.
 
 ## Features
 - Deploy a full Sensu stack, including RabbitMQ, Redis, and the [Uchiwa dashboard](https://uchiwa.io/#/)
@@ -7,8 +7,6 @@ This role deploys a full [Sensu](https://sensuapp.org) stack, a modern, open sou
 - Automatic generation and dynamic deployment of SSL certs for secure communication between your clients and servers
 - Highly configurable
 
-_Note:_ _Further documentation on features is coming_
-
 ## Supported Platforms
 This role has been written with [SmartOS](https://smartos.org) in mind, to be deployed to [zones](https://wiki.smartos.org/display/DOC/Zones)
 

+ 1 - 0
mkdocs.yml

@@ -4,6 +4,7 @@ repo_url: https://github.com/cmacrae/ansible-sensu/
 site_description: An Ansible role to deploy a fully dynamic Sensu stack!
 site_author: Calum MacRae
 
+theme: flatly
 pages:
   - [ 'index.md', 'Index' ]
   - [ 'example_infra.md', 'Usage', 'Example infrastructure layout' ]