Merge pull request #1 from mmagr/github

Updates platform name on docs

README.md

@@ -1,6 +1,6 @@
-# CPqD IoT Middleware documentation
+# dojot documentation
 
-This repository contains the high-level documentation for CPqD's IoT Middleware platform.
+This repository contains the high-level documentation for dojot iot platform.
 For specific information regarding each of the sub-components that comprise the solution,
 please check the component's own documentation page.
 

source/architecture.rst

@@ -1,7 +1,7 @@
 Architecture
 ============
 
-This document describes the current architecture that guides the middleware implementation, detailing
+This document describes the current architecture that guides the platform implementation, detailing
 the components that comprise the solution, as well as their functionalities and how each of them
 contribute to the platform as a whole.
 
@@ -49,6 +49,6 @@ should be answered here.
 Comparative analysis
 --------------------
 
-This section should detail the features that differenciate the middleware from a "stock" deployment
+This section should detail the features that differenciate the platform from a "stock" deployment
 of fiware, as well as a feature summary comparing the proposed solution with a reduced set of
 third-party implementations of IoT platforms available.

source/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# IoT Middleware documentation build configuration file, created by
+# dojot documentation build configuration file, created by
 # sphinx-quickstart on Tue Feb 14 17:45:39 2017.
 #
 # This file is execfile()d with the current directory set to its
@@ -45,7 +45,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'IoT Middleware'
+project = u'dojot'
 copyright = u'2017, CPqD'
 author = u'Matheus Magalhaes'
 
@@ -103,7 +103,7 @@
 # -- Options for HTMLHelp output ------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'IoTMiddlewaredoc'
+htmlhelp_basename = 'dojotdoc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -130,7 +130,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'IoTMiddleware.tex', u'IoT Middleware Documentation',
+    (master_doc, 'dojot.tex', u'dojot Documentation',
      u'Matheus Magalhaes', 'manual'),
 ]
 
@@ -140,7 +140,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'iotmiddleware', u'IoT Middleware Documentation',
+    (master_doc, 'dojot', u'dojot Documentation',
      [author], 1)
 ]
 
@@ -151,8 +151,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'IoTMiddleware', u'IoT Middleware Documentation',
-     author, 'IoTMiddleware', 'One line description of project.',
+    (master_doc, 'dojot', u'dojot Documentation',
+     author, 'dojot', 'One line description of project.',
      'Miscellaneous'),
 ]
 

source/index.rst

@@ -1,12 +1,7 @@
-.. IoT Middleware documentation master file, created by
-   sphinx-quickstart on Tue Feb 14 17:45:39 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-IoT Middleware documentation
+dojot documentation
 ============================
 
-This is the high-level documentation for the IoT Middleware platform developed by CPqD. This platform
+This is the high-level documentation for dojot IoT platform developed by CPqD. This platform
 is largely based on [FIWARE](fiware.org), and aims to provide the application and device developers
 with a more concise and integrated interaction, while benefiting for the highly customizable and
 efficient infrastructure provided by FIWARE.

source/install/compose_guide.rst

@@ -2,8 +2,8 @@ Installation guide - Docker compose
 ===================================
 
 This document provides instructions on how to create a trivial deployment
-environment on single host of the IoT middleware, using docker-compose as
-the processes orchestration platform.
+environment on single host for dojot, using docker-compose as the processes
+orchestration platform.
 
 While very simple, this deployment option is best suited to development and
 assessment of the platform and should not be used for production environments.
@@ -45,22 +45,6 @@ be found at the project's documentation:
 
 https://docs.docker.com/compose/install/
 
-Internal Docker registry
-^^^^^^^^^^^^^^^^^^^^^^^^
-
-While the project is not released, an internal docker registry will be used
-to host the docker images built by jenkins as part of our CI/CD workflow.
-
-As of now, that registry has no valid TLS certificate associated with it,
-thus requiring the users of such registry to configure their docker engine
-clients to allow this particular insecure registry.
-
-To configure the machine's docker client to allow the internal registry, edit
-the docker engine parameters as follows.::
-
-  echo '{ "insecure-registries":["iotmid-docker:5000"] }' | sudo tee /etc/docker/daemon.json
-  sudo service docker stop
-  sudo service docker start
 
 Installation
 ------------
@@ -71,11 +55,11 @@ commands below.
 The docker-compose enabled deployment scripts and configuration repository
 can be found at:
 
-https://gerrit.cpqd.com.br/#/admin/projects/iot/middleware/deploy/compose
+https://github.com/dojot/docker-compose
 
-or as git clone command (do notice that the user has to be updated):::
+or as git clone command:::
 
-  git clone ssh://[user]@gerrit.cpqd.com.br:29418/iot/middleware/deploy/compose
+  git clone git@github.com:dojot/docker-compose.git
 
 Once the repository is properly cloned, select the version to be used by
 checking out the appropriate tag (do notice that the tagname has to be replaced): ::
@@ -89,12 +73,6 @@ That done, the environment can be brought up by: ::
   # May need sudo to work: sudo docker-compose up -d
   docker-compose up -d
 
-.. note::
-
-  Should the pulling of the container a container image fail, adding the explicit
-  reference to the internal registry may solve the problem.
-
-  Should that suffice or not, be sure to open a JIRA ticket for that error.
 
 To check individual container status, docker's commands may be used, for instance: ::
 
@@ -132,7 +110,7 @@ User creation
 ^^^^^^^^^^^^^
 
 To be able to use the system's web front-end and make API calls, a user must be created. To create
-a first `admin` user, the following script can be run on the host machine of the middleware (that 
+a first `admin` user, the following script can be run on the host machine of the platform (that
 is, the machine where docker-compose was run). The script is located at the root of the repository.
 ::
 

source/ops_guide.rst

@@ -1,8 +1,8 @@
 Operations Guide
 ================
 
-This document provides information on how to properly deploy and manage an instance of the IoT Middleware.
-For documentation regarding the usage of the Middleware from the perspective of either an application,
+This document provides information on how to properly deploy and manage an instance of dojot.
+For documentation regarding the usage of the platrom from the perspective of either an application,
 or device developer please refer to the [user guide]().
 
 .. contents:: Table of Contents
@@ -34,7 +34,7 @@ User Management
 ---------------
 
 This section should describe the steps required to configure user roles and role permissions for the
-middleware itself, as well as handle application authentication features.
+platform itself, as well as handle application authentication features.
 
 .. _resourceManagement:
 

source/user_guide.rst

@@ -1,45 +1,45 @@
 User Guide
 ==========
 
-This document provides information on how to use the IoT Middleware from a user perspective. On that
+This document provides information on how to use dojot from a user perspective. On that
 regard, this should describe the steps required to install and operate the platform from a device
 developer or application developer point of view. For documentation regarding the operation of the
-Middleware itself, please refer to the [operations guide]()
+platform itself, please refer to the [operations guide]()
 
 .. contents:: Table of Contents
   :local:
 
 Getting Started
 ---------------
 
-The idea here is to present the reader with a sample end-to-end usage of the middleware, showcasing
-a relevant set of the features implemented by the middleware, thus serving as an example of how to
-use the middleware on a "real world" scenario.
+The idea here is to present the reader with a sample end-to-end usage of the platform, showcasing
+a relevant set of the features implemented by the platform, thus serving as an example of how to
+use the platform on a "real world" scenario.
 
 To make things easier for the user, there may be a VM image with a pre-configured deployment of the
-middleware. Should this be the case, instructions on how to deploy the solution might reside only on
+platform. Should this be the case, instructions on how to deploy the solution might reside only on
 the Operations Guide.
 
 Device Management
 -----------------
 
 This section should detail how to integrate a new device with the system. That should encompass
 the both the communication requirements imposed on the device in order to allow its usage with
-the middleware, as well as the steps (if any, depending on the protocol used) to configure this
-new device within the middleware.
+the platform, as well as the steps (if any, depending on the protocol used) to configure this
+new device within the platform.
 
 This could also explain (if indeed implemented) the device management functionalities made available
-by the middleware to the device developer.
+by the platform to the device developer.
 
 Regarding the requirements imposed on the devices, it is forseen that, for each communication scheme
-(protocol/serialization format) offically supported by the middleware, a step by step guide on
-how to "develop" a device is supplied. Such guide can, if applicable, make use of a middleware-provided
+(protocol/serialization format) offically supported by the platform, a step by step guide on
+how to "develop" a device is supplied. Such guide can, if applicable, make use of a platform-provided
 library or SDK.
 
 Flow Management
 ---------------
 
 Moving to the perspective of an aplication developer, this section should list and explain the usage
-of the information flow configuration process within the middleware - how to use the provided gui,
+of the information flow configuration process within the platform - how to use the provided gui,
 high level description of the APIs that can be used to configure such flows, available actions to
 be used when building the flows, so on and so forth.