Skip to content

Commit 97906c9

Browse files
authored
Few more fixes related to rendering and attributions. Signed-off-by: Behera, Tushar Ranjan <[email protected]>
1 parent 1d163b3 commit 97906c9

File tree

5 files changed

+140
-128
lines changed

5 files changed

+140
-128
lines changed

docs/installation.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@ This document can be used as a quick start guide to setup the development enviro
66

77
| Component | Recommended |
88
|------- |------|
9-
| Operating System | Ubuntu 18.04 / Windows 10 |
10-
| Docker Engine | 18.09 |
11-
| Docker-compose | 1.21.2 |
12-
| maven | 3.5.4 |
9+
| Operating System | Ubuntu\* 18.04 / Windows\* 10 |
10+
| Docker* Engine | 18.09 |
11+
| Docker* Compose | 1.21.2 |
12+
| Maven* | 3.5.4 |
1313

1414
## Docker* Installation
15-
1 . Removing the older versions of Docker. If these are installed, uninstall them:
15+
1 . Removing the older versions of Docker*. If these are installed, uninstall them:
1616
```
1717
sudo apt-get remove docker docker-engine docker.io containerd runc
1818
```
@@ -30,27 +30,27 @@ sudo apt-get remove docker docker-engine docker.io containerd runc
3030
!!! NOTE
3131
If you are working behind a proxy, ensure to set proper proxy variables.
3232

33-
3 . Add Docker’s official GPG key:
33+
3 . Add official GPG key for Docker*:
3434
```
3535
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
3636
```
3737
4 . Use the following command to set up the **stable** repository.
3838
```
3939
sudo add-apt-repository \ "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ $(lsb_release -cs) \ stable"
4040
```
41-
5 . Update the `apt` package index and install the docker engine 18.09
41+
5 . Update the `apt` package index and install the Docker* Engine 18.09
4242
```
4343
sudo apt-get update
4444
sudo apt-get install docker-ce=5:18.09.9~3-0~ubuntu-bionic docker-ce-cli=5:18.09.9~3-0~ubuntu-bionic containerd.io
4545
```
46-
6 . Verify that Docker Engine is installed correctly by running the `hello-world` image.
46+
6 . Verify that Docker* Engine is installed correctly by running the `hello-world` image.
4747
```
4848
sudo docker run hello-world
4949
```
5050

5151
### Running the Docker* behind a proxy
5252

53-
To run the docker system behind a proxy server, the configuration is done by the following steps:
53+
To run the Docker* system behind a proxy server, the configuration is done by the following steps:
5454

5555
1 . Directory `docker.service.d` is to be created in systemd directory as shown below.
5656
```
@@ -83,7 +83,7 @@ Environment="HTTPS_PROXY=<Proxy IP/URL:Port>"
8383
}
8484
```
8585

86-
5 . After configuring the above, the docker needs to be restarted.
86+
5 . After configuring the above, the Docker* service needs to be restarted.
8787
```
8888
sudo systemctl daemon-reload
8989
sudo systemctl restart docker
@@ -94,10 +94,10 @@ sudo systemctl restart docker
9494
sudo systemctl show --property Environment docker
9595
```
9696

97-
## Docker-compose Installation
98-
To install a specific version of docker-compose (for example **_1.21.2_**) follow these steps:
97+
## Docker* Compose Installation
98+
To install a specific version of Docker\* Compose (for example **_1.21.2_**) follow these steps:
9999

100-
1 . Download the specific version **(1.21.2)** of docker-compose.
100+
1 . Download the specific version **(1.21.2)** of Docker* Compose.
101101
```
102102
sudo curl -L https://github.com/docker/compose/releases/download/1.21.2/docker-compose-`uname -s`-`uname -m` -o /usr/bin/docker-compose
103103
```

docs/iot-platform-sdk/development-guide.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ The implementation of these REST contracts in an OCS can be done in any programm
77
!!! Note
88
The implementation of the pre-defined contracts can be backed by non-REST interfaces as well. However, this would invlove updates to both OPS and To0Scheduler to facilitate communication with the newly defined interface at OCS. Such a change would involve, but is not limited to, updates to existing class `RestClient.java` at both OPS and To0Scheduler.
99

10-
## Rest Contracts between OCS (server) and OPS/To0Scheduler (client)
10+
## Rest Contracts between OCS(Server) and OPS/To0Scheduler(Client)
1111

12-
Following are the pre-defined REST API specifications for all the resource paths that must be implemented and exposed by an OCS implementation. Both, OPS and To0Scheduler make requests to the OCS implementation, as clients, using this format.
12+
The following are the pre-defined REST API specifications for all the resource paths that must be implemented and exposed by an OCS implementation. Both, OPS and To0Scheduler make requests to the OCS implementation, as clients, using this format.
1313

1414
| Operation | Description | Path/Query Parameters | Request Body | Response Body |
1515
| ---------------------------------------:|:------------------------------------------------------------:|:----------------------------------------:|:-------------:|--------------:|
@@ -35,7 +35,7 @@ Following are the pre-defined REST API specifications for all the resource paths
3535
| `DELETE` /v1/devices/{deviceId}/sessioninfo | Delete the TO2 session info corresponding to the `deviceId`. | Path: `deviceId`: Device identifier | | |
3636
| `GET` /devices/{deviceId}/resale | Get the `resale` flag indicating owner's support for resale of the corresponding `deviceId`. | Path: `deviceId`: Device identifier | | Boolean |
3737

38-
## Rest Contracts between To0Scheduler (server) and OCS (client)
38+
## Rest Contracts between To0Scheduler(Server) and OCS(Client)
3939

4040
An OCS implementation must, also, act as a client to trigger TO0 for set of devices, by making the following request to To0Scheduler. To0Scheduler accepts the request from OCS to initiate TO0 for the list of devices.
4141

@@ -46,7 +46,7 @@ An OCS implementation must, also, act as a client to trigger TO0 for set of devi
4646

4747
## Message Types
4848

49-
Following is a list of message types that are sent in the message body of each request/response. Each message type follows the standard JSON* schema. Statements after '#' inside the JavaScript Object Notation (JSON), represents the purpose of the field.
49+
Following is a list of message types that are sent in the message body of each request/response. Each message type follows the standard JSON\* schema. Statements after '#' inside the JavaScript* Object Notation (JSON), represents the purpose of the field.
5050

5151
### DeviceState
5252
This JSON* structure represents the state information of the device.
@@ -243,4 +243,4 @@ This JSON* structure represents the request message that is sent from the OCS to
243243
],
244244
"waitSeconds": String # Suggested number of seconds for which TO0 will be valid
245245
}
246-
```
246+
```

docs/iot-platform-sdk/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,4 +117,4 @@ Limitations of This Release
117117

118118
- The number of concurrent TO0 sessions are limited by a configuration property. TO0 requests for any numbers of devices may be dropped if this limit is reached.
119119

120-
- The keystore and truststore passwords are present in the configuration files as plain text. Special care must be taken to secure the configuration files.
120+
- The keystore and truststore passwords are present in the configuration files as plain text. Special care must be taken to secure the configuration files.

0 commit comments

Comments
 (0)