Update mkdocs (#18)

* Updates in section 1, 2 and 3 * Update content of different sections
martel-innovate · Mar 15, 2019 · db7ddd2 · db7ddd2
1 parent db49df7
commit db7ddd2
Show file tree

Hide file tree

Showing 19 changed files with 416 additions and 609 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,5 +2,8 @@ _build
 .cache
 .git
 
-#IDE
+# IDE
 .idea
+
+# Python virtual environment
+scripts/*/env
diff --git a/docs/1.essentials/3.steps_join.md b/docs/1.essentials/3.steps_join.md
@@ -2,13 +2,12 @@
 
 In order to actually become a new FIWARE Lab node, several activities
 are required from both the Node and FIWARE Lab admins. The first is the
-signature of a Letter of Intent in order to communicate to the node
-these steps, the SLA levels that they have to fulfil and the FIWARE Lab
-user data ownership and legislation to be applied in terms of Data
-Protection. Additionally, it is explained that the non-fulfilment of the
-SLA will produce a disconnection of the node from the FIWARE Lab. The
-Annex D: Letter of intent to become a new FIWARE Lab node contains the
-template of this Letter of Intent.
+signature of a *Letter of Intent to become a new FIWARE Lab node* in 
+order to communicate to the node these steps, the SLA levels that they 
+have to fulfil and the FIWARE Lab user data ownership and legislation 
+to be applied in terms of Data Protection. Additionally, it is explained 
+that the non-fulfilment of the SLA will produce a disconnection of the 
+node from the FIWARE Lab.
 
 The table below describes, step by step, the whole procedure as it is at
 the time of writing this document.
@@ -21,20 +20,19 @@ on the FIWARE Lab node.
 
 | **TASK** | **TASK DESCRIPTION** | **TASK OWNER** |
 | --- | --- | --- |
-| 00 | Sign the Letter to become a FIWARE Lab | Node Admin |
+| 00 | Sign the *Letter to become a new FIWARE Lab node*. | Node Admin |
 | 01 | Provide contacts information. | Node Admin |
 | 02 | Insert the new node within the agenda of the weekly meetings. | FIWARE Lab Admins
 | 03 | Join the weekly meetings. | Node Admin |
 | 04 | Join the <fiware-lab-federation-nodes@lists.fiware.org> mail list. | Node Admin + FIWARE Lab Admins |
-| 05 | Insert the new node in Jira for help-desk, sprint and FLUA management. | FIWARE Lab Admins |
+| 05 | Insert the new node in Jira for help-desk and FLUA management. | FIWARE Lab Admins |
 | 06 | Sign in for Jira account: <https://jira.fiware.org> | Node Admin |
-| 07 | Sign in for a FIWARE Lab account: <https://cloud.lab.fiware.org> | Node Admin
-| 08 | Webinar to explain how to use the main tools and methodology, such as Jira, Sprints, Help tickets, FLUAs. | Node Admin + FIWARE Lab Admins |
-| 09 | Create sprint activities | FIWARE Lab Admins |
-| 10 | Install the local OpenStack node | Node Admin |
-| 11 | Federate the node | Node Admin |
-| 12 | Update the federation data within the corresponding workitem created for the federation process | Node Admin |
-| 13 | Install and configure the monitoring system | Node Admin + FIWARE Lab Admins |
-| 14 | Configure the Sanity Check | Node Admins + FIWARE Lab Admins |
-| 15 | Insert the new node within Infographic, Health Status and Sanity Check | Node Admins + FIWARE Lab Admins |
-| 16 | Synchronize GE image list | FIWARE Lab Admins |
+| 07 | Request the creation of the FIWARE Lab administrator account: <https://cloud.lab.fiware.org> | Node Admin
+| 08 | Webinar to explain how to use the main tools and methodology such as Jira, Help tickets, FLUAs. | Node Admin + FIWARE Lab Admins |
+| 09 | Install the local OpenStack node. | Node Admin |
+| 10 | Federate the node. | Node Admin |
+| 11 | Update the federation data within the corresponding JIRA workitem created for the federation process. | Node Admin |
+| 12 | Install and configure the monitoring system. | Node Admin + FIWARE Lab Admins |
+| 13 | Configure the Sanity Check. | Node Admins + FIWARE Lab Admins |
+| 14 | Insert the new node within Infographic and Health Status. | Node Admins + FIWARE Lab Admins |
+| 15 | Synchronize GE image list. | FIWARE Lab Admins |
diff --git a/docs/1.essentials/4.steps_leave.md b/docs/1.essentials/4.steps_leave.md
@@ -6,22 +6,16 @@ important, which is the base of the FIWARE philosophy, is taking care of
 the migration of users toward a persistent node, in order to
 avoid service outage.
 
-The table below describes all steps, as they are now at the time of
-writing this document.
-
-Some steps may change in the near future due to the R6.4 of FIWARE
-Keyrock that includes the migration from Keyrock to Keystone and the
-Federation of OpenStack Keystone instances, therefore in short time all
-the nodes can use their own OpenStack Keystone instance and create use
-on the FIWARE Lab node.
+The table below describes all steps needed to discontinue a FIWARE Lab 
+node.
 
 | **TASK** | **TASK DESCRIPTION** | **TASK OWNER** |
 | --- | --- | --- |
-| 01 | Inform the FIWARE Lab management about your decision at least 1 month before the shutdown | Node Admin |
-| 02 | Inform all FIWARE Lab users about the shutdown via the FIWARE Lab notification tool | FIWARE Lab Admins |
-| 03 | Take care of the migration of all active users toward a persistent node | Node Admin + FIWARE Lab Admins |
-| 04 | Disconnect the node from centralized Keystone | Node Admin + FIWARE Lab Admins |
-| 05 | Delete the node from the list of available nodes in JIRA, FLUA, Sanity Check, Infographic, Health Status | FIWARE Lab Admins |
-| 06 | Delete from the [*fiware-lab-federation-nodes@lists.fiware.org*](mailto:fiware-lab-federation-nodes@lists.fiware.org) mail list | FIWARE Lab Admins |
-| 07 | Delete the node from the weekly meeting agenda/minute | FIWARE Lab Admins |
-| 08 | Ask the node to send a final report/lessons learnt | FIWARE Lab Admins + Node Admin|
+| 01 | Inform the FIWARE Lab management about your decision at least 1 month before the shutdown. | Node Admin |
+| 02 | Inform all FIWARE Lab users about the shutdown via the FIWARE Lab notification tool. | FIWARE Lab Admins |
+| 03 | Take care of the migration of all active users toward a persistent node. | Node Admin + FIWARE Lab Admins |
+| 04 | Disconnect the node from centralized Keystone. | Node Admin + FIWARE Lab Admins |
+| 05 | Delete the node from the list of available nodes in JIRA, FLUA, Sanity Check, Infographic, Health Status. | FIWARE Lab Admins |
+| 06 | Delete from the [*fiware-lab-federation-nodes@lists.fiware.org*](mailto:fiware-lab-federation-nodes@lists.fiware.org) mail list. | FIWARE Lab Admins |
+| 07 | Delete the node from the weekly meeting agenda/minute. | FIWARE Lab Admins |
+| 08 | Ask the node to send a final report/lessons learnt. | FIWARE Lab Admins + Node Admin|
diff --git a/docs/1.essentials/5.steps_status.md b/docs/1.essentials/5.steps_status.md
@@ -16,50 +16,48 @@ following operation:
 
 - HOW TO CHECK THE NODE NAME
 
-    ```
-    $ ssh login into one controller node
-    $ grep region_name /etc/nova/nova.conf
-    ```
+```
+$ ssh login into one controller node
+$ grep region_name /etc/nova/nova.conf
+```
 
 - HOW TO CHECK THE OPENSTACK VERSION
 
-    ```
-    $ ssh login into one controller node
-    $ nova-api --version
-    (e.g. 2015.1.1)
-    ```
+```
+$ ssh login into one controller node
+$ nova-api --version
+(e.g. 2015.1.1)
+```
 
-    Take note of 2015.1.1 and go to
-    [*https://wiki.openstack.org/wiki/Release_Naming*](https://wiki.openstack.org/wiki/Release_Naming)
-    to see the corresponding OpenStack release (in this example Kilo).
-
-    Alternatively it is possible to use semi-automatic scripts in this [repository](https://github.com/SmartInfrastructures/fiware-lab-refenv)
+Take note of 2015.1.1 and go to [*Release Naming*](https://releases.openstack.org) 
+to see the corresponding OpenStack release (in this example Kilo). Alternatively 
+it is possible to use semi-automatic scripts in this [repository](https://github.com/SmartInfrastructures/fiware-lab-refenv)
 
 - HOW TO CHECK THE MONITORING VERSION
 
-    ```
-    $ ssh login into one controller node
-    $ search the fiware-check-monitoring.sh script
-    $ run fiware-check-monitoring.sh -v
-    ```
+```
+$ ssh login into one controller node
+$ search the fiware-check-monitoring.sh script
+$ run fiware-check-monitoring.sh -v
+```
 
-    Check the text “FIWARE Lab Monitoring System release xxxx”
+  Check the text “FIWARE Lab Monitoring System release xxxx”
 
 - HOW TO CHECK THE INFOGRAPHIC STATUS
 
-    Go to [*http://infographic.lab.fiware.org*](http://infographic.lab.fiware.org)
+Go to [*http://infographic.lab.fiware.org*](http://infographic.lab.fiware.org)
 
-    Check the status of the node
+Check the status of the node
 
 - HOW TO CHECK THE HEALTH CHECK STATUS
 
-    Go to [*https://fi-health.lab.fiware.org*](https://fi-health.lab.fiware.org)
-    and check the Sanity Check status.
+Go to [*https://fi-health.lab.fiware.org*](https://fi-health.lab.fiware.org)
+and check the Sanity Check status.
 
-    Go to [*http://status.lab.fiware.org*](http://status.lab.fiware.org)
-    and check the historical performance of the node and available resources.
+Go to [*http://status.lab.fiware.org*](http://status.lab.fiware.org)
+and check the historical performance of the node and available resources.
 
 - HOW TO CHECK THE FEDERATION STATUS
 
-    Go to [*http://backlog.fiware.org/lab/backlog*](http://backlog.fiware.org/lab/backlog)
-    and check the closing date of the corresponding workitem.
+Go to the corresponding JIRA workitem created to see the status of the federation
+process.
diff --git a/docs/2.policies/1.introduction.md b/docs/2.policies/1.introduction.md
@@ -1,4 +1,4 @@
 # Policies
 
-The following section describes the Fiware Lab policies regarding privacy, the
+The following section describes the FIWARE Lab policies regarding privacy, the
 use of cookies, and the terms and conditions of usage.
diff --git a/docs/3.process/1.introduction.md b/docs/3.process/1.introduction.md
@@ -1,4 +1,4 @@
-# The Process of Joining Fiware Lab
+# Process for joining FIWARE Lab
 
-The following section will go into details to describe how to join Fiware Lab,
+The following section will go into details to describe how to join FIWARE Lab,
 from setting up a node to installing, configuring, upgrading and maintaining it.
diff --git a/docs/3.process/10.infographics.md b/docs/3.process/10.infographics.md
@@ -23,8 +23,7 @@ others run centrally on FIWARE Lab premises:
 
   [*https://github.com/SmartInfrastructures/fi-lab-infographics*](https://github.com/SmartInfrastructures/fi-lab-infographics)
 
-![FIWARE Lab
-Monitoring high level architecture.](image4.png)
+![FIWARE Lab Monitoring high level architecture](image4.png)
 
 Monitoring information collected by Ceilometer on each FIWARE Lab node
 flows to the central Monasca API server for persistency, they are then
@@ -38,8 +37,8 @@ must be successfully completed in the following order, as there are
 dependencies:
 
 1. Ceilometer must be installed and federated as explained in section
-    [How to setup a FIWARE Lab Node](3.installing.md#how). Moreover, it
-    should be able to collect OpenStack default monitoring data locally.
+    [How to install a FIWARE Lab Node](4.installing.md#How_to_install_a_FIWARE_Lab_Node). 
+    Moreover, it should be able to collect OpenStack default monitoring data locally.
 
 1. Ceilometer FIWARE plugin must be properly installed and configured
     on the node. It should be able to push all the FIWARE custom

diff --git a/docs/3.process/3.upgrade.md b/docs/3.process/3.upgrade.md
@@ -15,8 +15,8 @@ FIWARE Lab policy in use:
 
 ![FIWARE Lab OpenStack support model](image3.png)
 
-More information about the release series of OpenStack can be found at
-the following link: [https://releases.openstack.org](https://releases.openstack.org)
+More information about the release series of OpenStack can be found in the
+[OpenStack Release Naming policy](https://releases.openstack.org).
 
 * **IMPORTANT**: A FIWARE Lab Node not updated, will stop working properly because
   not compatible with FIWARE Lab services!
diff --git a/docs/3.process/4.installing.md b/docs/3.process/4.installing.md
@@ -4,7 +4,7 @@
 
 In order to install your FIWARE Lab Node you can choose among different
 options that allows you to deploy an updated version of Vanilla
-OpenStack compatible with the requirements listed in section [Essential things](../1.essentials).
+OpenStack compatible with the requirements listed in section [Essential things](../index.md).
 
 ### <a name="how"></a> How to install a FIWARE Lab Node
 
@@ -17,7 +17,7 @@ Puppet or Chef in order to provision and maintain such complex systems.
 Moreover Operating System Virtualization (Container-based) helps the
 management and the upgrade of all services running in the OpenStack
 based FIWARE Lab Node and it also grants the compatibility and
-portability of those services across different Operating Systems[^2].
+portability of those services across different Operating Systems.
 
 For the above reasons FIWARE suggests the usage of IT Automation tools
 and Container-based virtualization in order to setup and maintain FIWARE