added plugin-lifecycle and code-analysis-quality pages

freedomotic · Apr 15, 2017 · 963eb26 · 963eb26
1 parent cf391cf
commit 963eb26
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 2 deletions.
diff --git a/docs/source/_templates/index.html b/docs/source/_templates/index.html
@@ -31,6 +31,7 @@ <h1>{{ _('Freedomotic Developer Manual') }}</h1>
          - <a class="linkdescr" href="{{ pathto("plugins/what-is-a-plugin") }}">{%trans%}What is a plugin?{%endtrans%}</a><br/>
          - <a class="linkdescr" href="{{ pathto("plugins/plugin-manifest-configuration") }}">{%trans%}Plugin manifest and configuration{%endtrans%}</a><br/>
          - <a class="linkdescr" href="{{ pathto("plugins/create-a-new-plugin") }}">{%trans%}Create a new plugin{%endtrans%}</a><br/>
+          - <a class="linkdescr" href="{{ pathto("plugins/plugin-lifecycle") }}">{%trans%}Plugin lifecycle{%endtrans%}</a><br/>
          - <a class="linkdescr" href="{{ pathto("plugins/api") }}">{%trans%}Freedomotic APIs{%endtrans%}</a><br/>
          - <a class="linkdescr" href="{{ pathto("plugins/bind-things-state-to-hardware-data") }}">{%trans%}Bind things state to hardware data{%endtrans%}</a><br/>
          - <a class="linkdescr" href="{{ pathto("plugins/bind-things-state-to-web-services-data") }}">{%trans%}Bind things state to web services data{%endtrans%}</a><br/>
@@ -77,9 +78,10 @@ <h1>{{ _('Freedomotic Developer Manual') }}</h1>
          - <a class="linkdescr" href="https://plus.google.com/+freedomotic">{%trans%}Google+{%endtrans%}</a></br>
          - <a class="linkdescr" href="https://www.linkedin.com/groups/5099925">{%trans%}LinkedIn{%endtrans%}</a></br>
          - <a class="linkdescr" href="https://twitter.com/freedomotic">{%trans%}Twitter{%endtrans%}</a></br>
-
-
       </p>
+      <p class="biglink"><div class="section-title">{%trans%}Open source project management tools{%endtrans%}</div>
+         - <a class="linkdescr" href="{{ pathto("the-project/code-analysis-quality") }}">{%trans%}Code analysis and quality{%endtrans%}</a><br/>
+    </p>
 
     </td>
     </tr>

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -44,6 +44,7 @@ Contents:
    What is a plugin? <plugins/what-is-a-plugin>
    Plugins manifest and configuration <plugins/plugin-manifest-configuration>
    Create a new plugin <plugins/create-a-new-plugin>
+   Plugin lifecycle <plugins/plugin-lifecycle>
    Freedomotic APIs <plugins/api>
    Bind things state to hardware data <plugins/bind-things-state-to-hardware-data>
    Bind things state to web services data <plugins/bind-things-state-to-web-services-data>

diff --git a/docs/source/plugins/images/plugin-lifecycle.png b/docs/source/plugins/images/plugin-lifecycle.png
diff --git a/docs/source/plugins/plugin-lifecycle.rst b/docs/source/plugins/plugin-lifecycle.rst
@@ -0,0 +1,15 @@
+
+Plugin lifecycle
+================
+
+
+
+.. figure:: images/plugin-lifecycle.png
+    :width: 500px
+    :align: center
+    :height: 300px
+    :alt: Lifecycle of a plugin, showing both polling and push modes of operation
+    :figclass: align-center
+
+    Lifecycle of a plugin, showing both polling and push modes of operation (thanks to J.M. Fidalgo)
+
diff --git a/docs/source/the-project/code-analysis-quality.rst b/docs/source/the-project/code-analysis-quality.rst
@@ -0,0 +1,7 @@
+
+Code analysis and quality
+=========================
+
+`Codacy <https://www.codacy.com/app/mcicolella/freedomotic/dashboard>`_
+
+`Sonarqube <https://sonarqube.com/dashboard?id=com.freedomotic%3Afreedomotic>`_