Skip to content

Commit

Permalink
Fixed a lot of typos
Browse files Browse the repository at this point in the history
  • Loading branch information
arnaugarcia committed Nov 23, 2020
1 parent a31c57f commit 1683217
Show file tree
Hide file tree
Showing 12 changed files with 39 additions and 39 deletions.
2 changes: 1 addition & 1 deletion docs/api_docs/general_model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ and consists of the following parts:
(e.g. 8081).
- **service:** catalog, data, order, etc..

Every service has a custom URL format as especified for each services.
Every service has a custom URL format as specified for each services.

Representations
---------------
Expand Down
6 changes: 3 additions & 3 deletions docs/api_docs/security.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,9 @@ authorized entity ( provider or application ) is allowed to admin, write
or read in a resource.

These permissions are defined via the catalog console of the platform
and, by default, every entity is administrable by its owner.
and, by default, every entity can be administrated by its owner.

If an action on a resource is done without the appropiate permission,
If an action on a resource is done without the appropriate permission,
platform will return an error 403.

Securing Callbacks
Expand All @@ -74,7 +74,7 @@ This mechanisms guarantees:

- That the message was sent by the platform
- That the message was not altered after sent
- That the messege is still active
- That the message is still active

As hash algorithm the system uses
`SHA-512 <http://en.wikipedia.org/wiki/SHA-2>`__. It accepts keys of any
Expand Down
2 changes: 1 addition & 1 deletion docs/api_docs/services.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Services
========

Index of differents services.
Index of different services.

.. toctree::
:maxdepth: 1
Expand Down
10 changes: 5 additions & 5 deletions docs/architecture.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ RealTime storage

Primary repository where the platform stores all the information
received. It is configured to do periodic backups in the file system. It
is also the Publish/Subscrive engine.
is also the Publish/Subscribe engine.

REST API
^^^^^^^^
Expand Down Expand Up @@ -113,7 +113,7 @@ Please, check this out fore more `info <./api_docs/security.hml>`__.
Notification mechanism
^^^^^^^^^^^^^^^^^^^^^^

Sentilo provides two mechanisms for nofitying events:
Sentilo provides two mechanisms for notifying events:

- If the client is capable of having an opened socket, the platform
will send a notification to this socket every time an event is
Expand Down Expand Up @@ -141,7 +141,7 @@ Alert
Sentilo allows to manage sensor-level internal alerts, aimed to control
the validity of the data received. The set of conditional operators
available are: **>, >=, <, <=, =, any change, variation, frozen**. When
the value received from a sensor doesnt met any of the conditions
the value received from a sensor doesn't met any of the conditions
defined, the alert agent publishes an event (alarm) notifying it. These
alerts are defined through the `console <./catalog_and_maps.html>`__.
There are also external alerts which can be defined and triggered
Expand Down Expand Up @@ -171,7 +171,7 @@ into two layers:
Transport Layer
'''''''''''''''

Tthe transport layer is designed following the Thread Pool pattern and
The transport layer is designed following the Thread Pool pattern and
is implemented with Apache HttpCore library.

The following diagram shows the main flow for a request within this
Expand Down Expand Up @@ -214,7 +214,7 @@ Service Layer

The design of this layer has the main premise of minimizing the request
processing time, so all the main job is held in memory(Redis). Redis
stores data in a memory database but also has the posibility of disk
stores data in a memory database but also has the possibility of disk
storage to ensure the durability of the data.

The following diagram shows the main flow for a request within this
Expand Down
12 changes: 6 additions & 6 deletions docs/catalog_and_maps/administration_console.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ corresponding row.

When you select to add a new resource, a traditional form page is
displayed. Here, you must have filled in the mandatory fields before
clicking the *Save* button. If some mandatory field is not fiiled in or
clicking the *Save* button. If some mandatory field is not filed in or
it have a no valid value, the page shows you information about what is
wrong:

|new_provider_2.png|

Otherwise, the resource will be registered into the Catalog and you will
be redirect to the list page (at the top right corner you will see a
confirmation message that the resource have been succesfully created):
confirmation message that the resource have been successfully created):

|ComponentsTypes_create.png|

Expand All @@ -45,7 +45,7 @@ before deleting it:

|ComponentsTypes_delete.png|

If the resource has been succesfully removed, the list is reloaded and a
If the resource has been successfully removed, the list is reloaded and a
confirmation message is displayed at the top right corner:

|ComponentsTypes_deleted.png|
Expand Down Expand Up @@ -851,7 +851,7 @@ where
of the sensor.
- The *Additional information* tab displays the custom properties of
the sensor.
- The *Latest data* tab shows the latests observations received from
- The *Latest data* tab shows the latest observations received from
the sensor.

The main properties of the *Details* tab are the following:
Expand Down Expand Up @@ -1147,7 +1147,7 @@ field is case-sensitive. That means that you can search for full or
partial text contained in the identifier, type, trigger or status field.
If you want to search for certain trigger type, currently only searching
by trigger type’s code is possible (e.g. a search for “GT” would return
results in the above screen, whereas a search for “GT(40)” wouldnt).
results in the above screen, whereas a search for “GT(40)” wouldn't).

|alert_list.png|

Expand Down Expand Up @@ -1424,4 +1424,4 @@ The agent `Metrics Monitor Agent </integrations.html#metrics-monitor-agent>`__ g
.. |componenttypes_170_002.jpg| image:: ../_static/images/catalog_and_maps/componenttypes_170_002.jpg
.. |metrics_190_001.png| image:: ../_static/images/catalog_and_maps/metrics_190_001.png
.. |metrics_190_002.png| image:: ../_static/images/catalog_and_maps/metrics_190_002.png
.. |active_subs_190_001.png| image:: ../_static/images/catalog_and_maps/active_subs_190_001.png
.. |active_subs_190_001.png| image:: ../_static/images/catalog_and_maps/active_subs_190_001.png
2 changes: 1 addition & 1 deletion docs/catalog_and_maps/map_viewers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ Displaying complex data
In some cases, you may want to inform **complex data** as an observation
on Sentilo, such like a large json object. For these cases, Sentilo will
detect that the text is a json object and then it will be shown to you
as a prettyfied json value:
as a prettify json value:

|complex_data_170_001.jpg|

Expand Down
6 changes: 3 additions & 3 deletions docs/integrations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,7 @@ this page.
Activity Monitor Agent is configured with a set of .properties files in
:literal:`sentilo/sentilo-agent-activity-monitor/src/main/resources/properties`.

**subsription.properties**
**subscription.properties**

+-----------------------+-----------------------+-----------------------------------------+
| Property | Description | Comments |
Expand Down Expand Up @@ -226,7 +226,7 @@ data sources.
Historian Agent is configured with a set of .properties files in
:literal:`sentilo/sentilo-agent-historian/src/main/resources/properties`.

**subsription.properties**
**subscription.properties**

+-----------------------+-----------------------+---------------------------------------+
| Property | Description | Comments |
Expand Down Expand Up @@ -301,7 +301,7 @@ The agent is installed at the side of the receiving instance:

.. image:: _static/images/integrations/sentilo_federation.png

The administrator of the emmitting Sentilo instance only needs to create a new application and provide the token the
The administrator of the emitting Sentilo instance only needs to create a new application and provide the token the
administrator of the receiving instance.
As with any Sentilo application, the administrator is in control of which provider's data are readable by the remote federation agent.

Expand Down
18 changes: 9 additions & 9 deletions docs/multitenant.rst
Original file line number Diff line number Diff line change
Expand Up @@ -106,13 +106,13 @@ Platform console
~~~~~~~~~~~~~~~~

**Super Admin** users should access to the catalog console without
informing any organization iddentifier in the url. In this case, no data
informing any organization identifier in the url. In this case, no data
is filtered by organization, and all the public information is visible
in the public map and statistics:

- http://your_sentilo_server_ip/sentilo-catalog-web

Super Admin users are responsibles of configure the platform
Super Admin users are responsible of configuring the platform
organizations and its users, and also to define the component and sensor
typologies.

Expand All @@ -136,7 +136,7 @@ information, specifying a different URL context:

For example, we could access to an organization named **Sample
Organization**, with a **sample_organization** as organization
identifier in a Senilo instance deployed in a host with name
identifier in a Sentilo instance deployed in a host with name
**example.com**:

- http://example.com/sentilo-catalog-web/sample_organization
Expand All @@ -151,7 +151,7 @@ section <./catalog_and_maps.html>`__.
Platform administration
-----------------------

Super Admin users are responsibles of configure the platform
Super Admin users are responsible of configuring the platform
organizations and its users, and also to define the component and sensor
typologies. They cannot see any organization data, such as components,
sensors, alerts.
Expand Down Expand Up @@ -348,14 +348,14 @@ Admin role users are directly related with an specific organization.
They are the only ones who are able to administer the organization
private data, such as its providers, applications, components, sensors
and alarms. They can also manage its own users. The admin users will
also be capable of seeng all the defined component and sensor
also be capable of seeing all the defined component and sensor
typologies, but they wont be able to modify them.

Basically, the only difference between the simple Sentilo instance and a
Multi Tenant instace version is that only users from one organization
Multi Tenant instance version is that only users from one organization
can see and access to information from its own organization. It’s also
possible to share information with another organitzations, as described
later. This data isolation make possible taking advantadge of user and
possible to share information with another organizations, as described
later. This data isolation make possible taking advantage of user and
organization hierarchy.

Below, we review the specific behaviour of tenant administration,
Expand All @@ -379,7 +379,7 @@ Permission administration
^^^^^^^^^^^^^^^^^^^^^^^^^

+-----------------------------------+-----------------------------------+
| Permission type | Functionallity |
| Permission type | Functionality |
+===================================+===================================+
| **To third party organizations | Grant read / write permissions to |
| from us** | other organizations over our |
Expand Down
4 changes: 2 additions & 2 deletions docs/platform_testing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@ To disable it, you must provide a JVM Tomcat parameter:

-Dsentilo.state_page.enabled=false

Then, the status page will be innaccessible:
Then, the status page will be inaccessible:

|status_170_003.jpg|

Postman tests
-------------

To test the API REST services individually, you can also test end-end
funcionality with `Postman <https://www.getpostman.com>`__, or if you
functionality with `Postman <https://www.getpostman.com>`__, or if you
prefer CLI, via
`Newsman <https://www.getpostman.com/docs/postman/collection_runs/command_line_integration_with_newman>`__:

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Quickstart
==========

Prequisites
Perquisites
-----------

You should have 4 components up & running:
Expand Down
12 changes: 6 additions & 6 deletions docs/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,18 +3,18 @@ Setup

This guide describes how to: **download, configure, compile and install
the last version of Sentilo in your own runtime environment**. Moreover,
it details which are the infraestructure elements necessary for running
it details which are the infrastructure elements necessary for running
Sentilo and how should be their default configuration settings. It’s
assumed you have the skils to configure and install the necessary
sofware base(Operating System, Maven,JDK, Mongo DB, Redis, etc).
assumed you have the skills to configure and install the necessary
software base(Operating System, Maven,JDK, Mongo DB, Redis, etc).

The main topics are:

- **Prerequisites**: describes the software elements that have to be
installed before download the code.
- **Download and build**: explains the steps to obtain the Sentilo
code, to adapt it and how to build the platform artifacts.
- **Platform infraestructure**: describes the mandatory infraestructure
- **Platform infrastructure**: describes the mandatory infrastructure
components for running Sentilo and its default configuration
settings.
- **Deploy the artifacts**: describes the necessary steps to deploy all
Expand Down Expand Up @@ -71,7 +71,7 @@ settings that are defined), we distribute a script named
command line.

This script compiles the code and build the artifacts from scratch, but
it doesnt deploy them in the excution environments. This process must
it doesn't deploy them in the execution environments. This process must
be done manually by different reasons, for example:

- The deployment environment could be distributed in different servers.
Expand All @@ -96,7 +96,7 @@ how to do it by using the M2E plugin.
your Eclipse environment.

After modifying the code, to compile and build the artifacts, our
recommendation is to use the abovementioned\* buildSentilo\* script.
recommendation is to use the above mentioned\* buildSentilo\* script.

Platform infrastructure
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/technical_faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ In which platforms has been Sentilo tested ?
--------------------------------------------

The first deployment for the Barcelona City Council has been tested in
the following infraestructure:
the following infrastructure:

- Four virtual machines, two for the front-ends and another two for the
back-end
Expand Down

0 comments on commit 1683217

Please sign in to comment.