Main readme small changes, TYPO

bringauto · Jan 26, 2022 · 3e51498 · 3e51498
1 parent 906a1dc
commit 3e51498
Show file tree

Hide file tree

Showing 11 changed files with 36 additions and 29 deletions.
diff --git a/BE/Artin.BringAuto/appsettings.json b/BE/Artin.BringAuto/appsettings.json
@@ -31,7 +31,7 @@
   },
   "MqttConfig": {
     "Enable": true,
-    "Host": "35.210.137.151",
+    "Host": "<MyNiceMosquittoIPAddress>",
     "Port": 1883,
     //"CertFiles": [
     //  {

diff --git a/README.md b/README.md
@@ -3,11 +3,11 @@
 
 BringAuto Industrial Portal is a system that connects autonomous platforms with the end-user!
 
-Users can add orders, monitor the state of the platform, receive notifications about order fulfil, ... - has a complete overview about the platform.
+Users can add orders, monitor the state of the autinomous fleet, receive notifications about order fulfil, ... - has a complete overview about all platforms in the fleet.
 
 Main features
 
-- Simple end-user interface for autonomous platform control,
+- Simple end-user interface for managing fleet of autonomous vehicles,
 - Datastream for autonomous platform provider for further data processing (platform statistics)
 
 ![industrial portal](./doc/gif/Main_IndustrialPortal.gif)
@@ -17,21 +17,21 @@ Main features
 End-user
 
 - add order to the autonomous platform
-- receive notification about order complete
+- receive notifications
 - check stats of the platform like remaining battery, completed orders,
-- check approximately
+- monitor position of the platform
 
 Platform provider
 
 - consistent data stream
-- workflows for industrial portal deployment (how to create a map)
-- simple and general high customizable communication protocol between Autonomy system and the Industrial Platform
+- workflows for industrial portal deployment
+- simple and general highly customizable communication protocol between Autonomy system and the Autonomous Platform
 - virtual environment for testing and development - [Etna]
 
 ## Deploy Test Environment
 
 You can deploy test instance of Industrial Portal
-to Docker by our Virtual Environment [Etna] by [Run Test Environment].
+to Docker using our Virtual Environment called [Etna], check all steps in [Run Test Environment].
 
 ## How to connect your Autonomous Platform
 
@@ -41,6 +41,10 @@ to connect to the Industrial Portal.
 For the development and test purposes the [Etna] system can be used to
 simulate/test/develop each part of BringAuto Industrial Portal.
 
+## Documentation
+
+Detailed documentation can be found in [doc/] directory located in the repository root.
+
 ## Create a feature/bug report
 
 If you found a bug or have an idea for a nice improvement please
@@ -61,4 +65,4 @@ If you need help please consider the use of [GitHub Discussion]
 [GitHub Issue tracker]: https://github.com/bringauto/industrial-portal/issues
 [GitHub Discussion]: https://github.com/bringauto/industrial-portal/discussions
 [BringAuto Autonomy Host Protocol]: https://drive.google.com/drive/folders/1ZE9VRs86QtP6GqTJBl6vRJLmkh1lTEc5
-
+[doc/]: ./doc
diff --git a/doc/Car.md b/doc/Car.md
@@ -5,10 +5,10 @@ Car has following attributes
 
 - `name: string`. Name of the car which will be shown in the GUI
 - `companyName: string`. Name of the company to which the Car belongs to
-- `underTest: bool`. If se to true we say that the car is in the test mode. If false the car is in normal mode.
+- `underTest: bool`. If set to true we say that the car is in the test mode. If false the car is in normal mode.
 - `routeId: int!`. Id of the Route entity. Each car can have assigned a Route
-- `carAdminPhone: string`. Phone to which the notofication about station deprature will be delivered
-- `callTwiml: string`. Twilio ML for station deperture notification
+- `carAdminPhone: string`. Phone to which the notification about station departure will be delivered
+- `callTwiml: string`. Twilio ML for station departure notification
 - `fuel: float!`. Battery level in percents. Standard values lies in [0, 1]
 
 Warning: not all attributes can be changed by GraphQL API.

diff --git a/doc/Order.md b/doc/Order.md
@@ -1,19 +1,19 @@
 
 # Order
 
-Order represents order that mush be full filled
+Order represents order that must be fulfilled
 
-- `arrive: DateTime`. When tha car should arrive/fulfill the order.
+- `arrive: DateTime`. When the car should arrive/fulfill the order.
 - `car: Car`. The [Car] to which the Order is assigned
 - `to: Station`. The [Station] TO which the car should go.
 - `toStationPhone: string`.
-- `from: Station`. The [Station] FROM the car should start
+- `from: Station`. The [Station] FROM which the car should start
 - `fromStationPhone: string`. 
 - `priority: OrderPriority`. Priority of the order. OrderPriority = { LOW, NORMAL, HIGH }
 - `status: OrderStatus`. OrderStatus = { TOACCEPT, ACCEPTED, INPROGRESS, DONE, CANCELED }
 - `user: User`. [User] who's made the order
 
-By GUI the order can be created by [SimpleOrder] or [GroupOrder]
+In GUI the order can be created by [SimpleOrder] or [GroupOrder]
 
 
 [Car]: ./Car.md

diff --git a/doc/README.md b/doc/README.md
@@ -8,7 +8,7 @@ Industrial Portal is divided into two main parts
 
 Frontend is standard user interface written in vue.js.
 
-Backend stores and process data from an autonomous platform and serve these
+Backend stores and process data from an autonomous platform and serves these
 data to FE in simple form ([GraphQL] API)
 
 Main entities served by BE to FE:

diff --git a/doc/Route.md b/doc/Route.md
@@ -9,16 +9,16 @@ Station is a place where the car stops and waits for load/unload.
 
 Properties
 
-- `color: string`. String which represents color in format #FFFFFF
+- `color: string`. String which represents color in hex format #FFFFFF
 - `name: string`. Name of the route
 - `stops: [RouteStop]`
 - `RouteStop`:
   - `latitude: float`
   - `longitude: float`
-  - `order: int`. The route is constructed by sort of stops by `order` from the smallest to the largest
+  - `order: int`. The route is constructed by sorting stops by `order` from the smallest to the largest
   - `station: StationInfo`
   - `StationInfo`:
-  	- `id: int`. Id of the [Station] entity. other fields like `name` and `conactPhone` are taken from [Station] entity repersented by id
+  	- `id: int`. Id of the [Station] entity. other fields like `name` and `contactPhone` are taken from [Station] entity represented by id
 	- `name: string`. Id
 	- `contactPhone: string`. [Station] contact phone for Twilio notification
 

diff --git a/doc/RunTestEnvironment.md b/doc/RunTestEnvironment.md
@@ -27,4 +27,7 @@ Prerequisites
 - `git clone https://github.com/bringauto/industrial-portal-init.git`
 - `cd industrial-portal-init`
 - `pip3 install -r requirements.txt`
-- `python3 main.py`
+- `python3 main.py`
+
+## Connect to industrial portal
+- Log into industrial portal on https://127.0.0.1:8011 using default account and password (Admin, Admin1)
diff --git a/doc/SimpleOrder.md b/doc/SimpleOrder.md
@@ -1,7 +1,7 @@
 
 # Simple Order
 
-Simple order just add exactly one order to the [Mission].
+Simple order adds exactly one station to the [Mission].
 
 
 ## Add simple order
@@ -10,7 +10,7 @@ Simple order just add exactly one order to the [Mission].
 
 ![car status](./img/CarStatus.png)
 
-- choose car and station where the autonomous platform shall g
+- choose car and station where the autonomous platform shall go
 
 ![simple order](./img/SimpleOrder.png)
 

diff --git a/doc/Station.md b/doc/Station.md
@@ -1,11 +1,11 @@
  # Station
 
-Station is a place where the can load/unload cargo.
+Station is a place where the car can load/unload cargo.
 
 Properties
 
 - `name: string`. Name of the Station that will be shown in the GUI
-- `contactPhone: string`. Context phone of the station used for Twilio notification
+- `contactPhone: string`. Contact phone of the station used for Twilio notification
 - `latitude: float`. Latitude of the station ([WGS84])
 - `longitude: float`. longitude of the station ([WGS84])
 - `id: int`. Station database ID

diff --git a/doc/User.md b/doc/User.md
@@ -1,7 +1,7 @@
 
 # User
 
-standard user which interacs with application.
+Standard user which interacts with application.
 
 Each user is identified by `userName` and `email`.
 

diff --git a/doc/UserRoles.md b/doc/UserRoles.md
@@ -1,9 +1,9 @@
 
 # User Roles
 
-There are theee main user roles
+There are three main user roles
 
-- `Admin` - administrator of the system. User with role Admin is called Administrator. Can change/update map, stations, routes, cars etc..
-  Orders created by Administrator can be view only by Administrator.
+- `Admin` - administrator of the system. User with role Admin is called Administrator. Can change/update map, stations, routes, cars etc...
+  Orders created by Administrator can be viewed only by Administrator.
 - `Driver` - security driver of the vehicle (remote or in-place). Can change state of the order, add/delete new orders.
 - `User` - can add and delete orders.