Merge pull request #1552 from k0ste/master

fixed docs
shinken-solutions · Mar 27, 2015 · 27f1962 · 27f1962
2 parents 31401a5 + b9bad3a
commit 27f1962
Show file tree

Hide file tree

Showing 11 changed files with 84 additions and 114 deletions.
diff --git a/doc/source/11_integration/pnp.rst b/doc/source/11_integration/pnp.rst
@@ -94,23 +94,24 @@ Then restart broker :
 
 ::
 
-  # /etc/init.d/shinken-broker restart</code>
+  # /etc/init.d/shinken-broker restart
 
 
 Share users with Thruk 
 =======================
 
 
-  Edit ''/etc/httpd/conf.d/pnp4nagios.conf'' (RedHat path) and replace AuthName and AuthUserFile with:
-  <code>
+  Edit /etc/httpd/conf.d/pnp4nagios.conf (RedHat path) and replace AuthName and AuthUserFile with:
+
+::
+
   AuthName "Thruk Monitoring"
   AuthUserFile /etc/thruk/htpasswd
 
 
 Then restart Apache:
 
 ::
-
   
   service httpd restart
 
@@ -166,7 +167,7 @@ Restart shinken-arbiter and you are done.
 
 ::
 
-  /etc/init.d/shinken-arbiter restart</code>
+  /etc/init.d/shinken-arbiter restart
 
 .. _PHP4Nagios installation: http://docs.pnp4nagios.org/pnp-0.6/install 
 .. _Thruk doc: http://www.thruk.org/documentation.html#_pnp4nagios_graphs

diff --git a/doc/source/11_integration/tcpwrappers.rst b/doc/source/11_integration/tcpwrappers.rst
@@ -32,16 +32,16 @@ Next, define a service in one of your :ref:`object configuration files <configur
 
 ::
 
-  define service{
-      " " " " host_name " " " " " " " " " " " firestorm
-      " " " " service_description " " " " " " TCP Wrappers
-      " " " " is_volatile " " " " " " " " " " 1
-      " " " " active_checks_enabled " " " " " 0
-      " " " " passive_checks_enabled " " " " "1
-      " " " " max_check_attempts " " " " " " "1
-      " " " " check_command " " " " " " " " " check_none
-      " " " " ...
-      " " " " }
+  define service {
+    host_name				firestorm
+    service_description			TCP Wrappers
+    is_volatile				1
+    active_checks_enabled		0
+    passive_checks_enabled		1
+    max_check_attempts			1
+    check_command			check_none
+    ...
+    }
   
 There are some important things to note about the above service definition:
 

diff --git a/doc/source/13_monitoring/iis.rst b/doc/source/13_monitoring/iis.rst
@@ -73,41 +73,27 @@ Find your host definition and edit it:
 Under Linux:
 
 ::
-
-  
   
-::
-
   linux:~ # vi /etc/shinken/hosts/srv-win-1.cfg
   
 Or Windows:
 
 ::
-
-  
   
-::
-
   c:\ wordpad   c:\shinken\etc\hosts\srv-win-1.cfg
   
-  
 All you need it to add the good template for your host. For example for a Hub Transport server:
 
 ::
 
-  
-  
-::
-
-  define host{
+  define host {
       use             iis,windows
       host_name       srv-win-1
       address         srv-win-1.mydomain.com
       }
   
-  
 
-* The use iis is the "template" line. It mean that this host will **inherits** properties from this template.
+  * The use iis is the "template" line. It mean that this host will **inherits** properties from this template.
   * the host_name is the object name of your host. It must be **unique**.
   * the address is ... the network address of your host :)
 

diff --git a/doc/source/13_monitoring/linux.rst b/doc/source/13_monitoring/linux.rst
@@ -70,14 +70,14 @@ RedHat like:
 
 ::
 
-  #yum install snmpd
+  yum install snmpd
 
 
 Debian like:
 
 ::
 
-  #apt-get install snmpd
+  apt-get install snmpd
 
 
 Edit the /etc/snmp/snmpd.conf and comment the line:

diff --git a/doc/source/13_monitoring/routers.rst b/doc/source/13_monitoring/routers.rst
@@ -75,7 +75,7 @@ Remove the leading pound (#) sign from the following line in the main configurat
 
 ::
 
-  #cfg_file=/etc/shinken/objects/switch.cfg
+  cfg_file=/etc/shinken/objects/switch.cfg
   
 Save the file and exit.
 

diff --git a/doc/source/14_contributing/help-the-project.rst b/doc/source/14_contributing/help-the-project.rst
diff --git a/doc/source/14_contributing/how-to-contribute.rst b/doc/source/14_contributing/how-to-contribute.rst
@@ -11,11 +11,11 @@ Shinken resources for users (help) :
 =====================================
 
 
-    * ` Shinken documentation`_
+    * `Shinken documentation`_
     * :ref:`Shinken Troubleshooting FAQ <troubleshooting/troubleshooting-shinken>`
-    * ` Support Forums`_
-    * ` Shinken issues and bug reports`_
-    * ` Shinken Ideas`_
+    * `Support Forums`_
+    * `Shinken issues and bug reports`_
+    * `Shinken Ideas`_
 
 
 The documentation wiki contains a **Getting started** section for how-to and tutorial related information. It also hosts an official documentation that has the full in-depth details and a how to contribute section where you can learn how to help grow Shinken.
@@ -26,7 +26,7 @@ Your input and support is a precious resource. If the documentation is not clear
 Ways to contribute : 
 =====================
 
-    * help on the documentation ` Shinken documentation`_
+    * help on the documentation `Shinken documentation`_
     * help on updating this web site
     * help on tracking and fixing bugs, `Shinken is on github`_ to make it easy!
     * coding new features, modules and test cases
@@ -35,7 +35,7 @@ Ways to contribute :
     * submitting ideas to Shinken Ideas
     * responding to questions on the forums
 
-//Guidelines and resources are described for users in the first section and power users and developers in the second section.//
+.. tip::  Guidelines and resources are described for users in the first section and power users and developers in the second section.
 
 
 Shinken Guidelines for developers and power users : 
@@ -51,10 +51,10 @@ Guidelines that should be followed when contributing to the code
 
 Resources for developers and power users
 
-    * Development - Collaborative code repository on ` Shinken github`_
-    * Development - Bug tracking on ` Shinken github`_
-    * Development - Automated test and integration on ` Shinken Jenkins server`_ ` Shinken Jenkins server`_
-    * Development - The forums are also a good medium to discuss issues ` Support Forums`_
+    * Development - Collaborative code repository on `Shinken github`_
+    * Development - Bug tracking on `Shinken github`_
+    * Development - Automated test and integration on `Shinken Jenkins server`_
+    * Development - The forums are also a good medium to discuss issues `Support Forums`_
     * Development - Developer Mailing list - `Register or search the shinken-devel Mailing list`_
 
 For bug hunting and programming, you will need to look at the “How to hacking" tutorial page.
@@ -65,14 +65,12 @@ There is a development mailing list where you can join us. Come and let us know
 
 Thank you for your help in making this software an open source success.
 
-Happy New Year to all Shinken followers, users and developers. xkilian 
-(If you find this you are lucky or tracking changes. ;-)
-
-.. _ Shinken issues and bug reports: https://github.com/naparuba/shinken/issues?sort=created&direction=desc&state=open
+.. _Shinken issues and bug reports: https://github.com/naparuba/shinken/issues?sort=created&direction=desc&state=open
 .. _Register or search the shinken-devel Mailing list: https://lists.sourceforge.net/lists/listinfo/shinken-devel
-.. _ Shinken github: https://github.com/naparuba/shinken/issues?sort=created&direction=desc&state=open
-.. _ Shinken Ideas: http://shinken.ideascale.com/
-.. _ Shinken documentation: http://shinken.readthedocs.org/
-.. _ Shinken Jenkins server: https://test.savoirfairelinux.com/view/Shinken/ 
+.. _Shinken github: https://github.com/naparuba/shinken/issues?sort=created&direction=desc&state=open
+.. _Shinken Ideas: http://shinken.ideascale.com/
+.. _Shinken documentation: http://shinken.readthedocs.org/
+.. _Shinken Jenkins server: https://test.savoirfairelinux.com/view/Shinken/ 
 .. _Shinken is on github: https://github.com/naparuba/shinken
-.. _ Support Forums: http://www.shinken-monitoring.org/forum/index.php
+.. _Support Forums: http://forum.shinken-monitoring.org/
+
diff --git a/doc/source/14_contributing/index.rst b/doc/source/14_contributing/index.rst
@@ -13,8 +13,7 @@ How to contribute
 
 .. toctree::
 
-    create-and-push-packs
-    create-a-package
-    help-the-project
+    packs
+    modules
     how-to-contribute
     spm
diff --git a/...urce/14_contributing/create-a-package.rst → doc/source/14_contributing/modules.rst b/...urce/14_contributing/create-a-package.rst → doc/source/14_contributing/modules.rst
@@ -1,4 +1,4 @@
-.. _contributing/create-a-package:
+.. _contributing/modules:
 
 ==================================
 Shinken modules
@@ -11,7 +11,7 @@ Packages layout
 For a MODULE named ABC (ex: `github.com/shinken-monitoring/mod-ip-tag`_ )
   * etc/modules/abc.cfg
   * module/module.py
-  *       /__init__.py
+  * /__init__.py
   * package.json
 
 That"s ALL!
@@ -23,31 +23,31 @@ The package.json file
 The package.json is like this:
 
 ::
-
-{
-  "name": "ip-tag",
-  "types": ["module"],
-  "version": "1.4.1",
-  "homepage": "http://github.com/shinken-monitoring/mod-ip-tag",
-  "author": "Jean Gabès",
-  "description": "Tag host by their IP ranges",
-  "contributors": [
+  
+  {
+    "name": "ip-tag",
+    "types": ["module"],
+    "version": "1.4.1",
+    "homepage": "http://github.com/shinken-monitoring/mod-ip-tag",
+    "author": "Jean Gabès",
+    "description": "Tag host by their IP ranges",
+    "contributors": [
     {
       "name": "Jean Gabès",
       "email": "naparuba@gmail.com"
     }
-  ],
-  "repository": "https://github.com/shinken-monitoring/mod-ip-tag",
-  "keywords": [
+    ],
+    "repository": "https://github.com/shinken-monitoring/mod-ip-tag",
+    "keywords": [
     "module",
     "arbiter",
     "ip"
-  ],
-  "dependencies": {
-    "shinken": ">=1.4"
-  },
-  "license": "AGPL"
-}
+    ],
+    "dependencies": {
+	"shinken": ">=1.4"
+    },
+    "license": "AGPL"
+  }
 
 
 How to publish it 

diff --git a/...14_contributing/create-and-push-packs.rst → doc/source/14_contributing/packs.rst b/...14_contributing/create-and-push-packs.rst → doc/source/14_contributing/packs.rst
@@ -1,4 +1,4 @@
-.. _contributing/create-and-push-packs:
+.. _contributing/packs:
 
 ==============
 Shinken packs
@@ -30,41 +30,41 @@ Let take a simple example with a linux pack, with CPU/Memory/Disk checks via SNM
 What does a package.json looks like? 
 ====================================
 
-It's a json file that describe your "pack". It will give it its name, where it should be installed, and if need give some macros provided by the host tags so it will be easier to configure in the SkonfUI.
+It's a json file that describe your "pack". It will give it its name, where it should be installed, and if need give some macros provided by the host tags.
 
 Let use our linux-smnp sample:
 
 ::
-
   
-{
+
+  {
     "name": "linux-snmp",
     "types": ["pack"],
     "version": "1.4",
     "homepage": "https://github.com/shinken-monitoring/pack-linux-snmp",
     "author": "Jean Gabès",
     "description": "Linux checks based on SNMP",
     "contributors": [
-        {
-            "name": "Jean Gabès",
-            "email": "naparuba@gmail.com"
-        },
-        {
-            "name": "David Moreau Simard",
-            "email": "moi@dmsimard.com"
-        }
+    {
+    "name": "Jean Gabès",
+    "email": "naparuba@gmail.com"
+    },
+    {
+    "name": "David Moreau Simard",
+    "email": "moi@dmsimard.com"
+    }
     ],
     "repository": "https://github.com/shinken-monitoring/pack-linux-snmp",
     "keywords": [
-        "pack",
-        "linux",
-        "snmp"
+	"pack",
+	"linux",
+	"snmp"
     ],
     "dependencies": {
-        "shinken": ">=1.4"
+	"shinken": ">=1.4"
     },
     "license": "AGPL"
-}
+  }
 
 
   * name -> The name of your pack. Directory with this name will be created on your /etc/shinken/packs
@@ -73,7 +73,7 @@ Let use our linux-smnp sample:
   * homepage -> Homepage of pack, is usual a github repo
   * author -> Maintainer of package
   * contributors -> People, who makes changes in this package
-  * repository -> Sources
+  * repository -> Repo with source code
   * keywords -> Help for search via shinken CLI or shinken.io website
   * dependencies -> Describe versions of software need to all works okay. Can provide any strings, besides shinken version