Skip to content

Commit b00dcbe

Browse files
minor fixes (typos, grammar, etc.)
1 parent cb87188 commit b00dcbe

File tree

2 files changed

+13
-13
lines changed

2 files changed

+13
-13
lines changed

docs/contributing/guidelines/ci.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ Continuous integration (CI) testing is an integral part of the Mbed OS contribut
44

55
## Github Actions
66

7-
Mbed OS uses Github actions as the primary automatic testing and checking run environment.
7+
Mbed OS uses Github Actions as the primary automatic testing and checking run environment.
88

9-
Its configuration is located in the [github/workflows/basic_checks.yml](https://github.com/ARMmbed/mbed-os/blob/master/.github/workflows/basic_checks.yml) file in the Mbed OS root directory.
9+
The configuration is located in the [github/workflows/basic_checks.yml](https://github.com/ARMmbed/mbed-os/blob/master/.github/workflows/basic_checks.yml) file in the Mbed OS root directory.
1010

1111
### Tests
1212

@@ -22,7 +22,7 @@ Its configuration is located in the [github/workflows/basic_checks.yml](https://
2222

2323
## Jenkins
2424

25-
We use [Jenkins](https://jenkins.io/) as an internal testing and checking environment. We execute tests that have special requirements for the execution enviroment in our internal Jenkins. In most cases, we publish test logs.
25+
We use [Jenkins](https://jenkins.io/) as an internal testing and checking environment. We execute tests that have special requirements for the execution environment in our internal Jenkins. In most cases, we publish test logs.
2626

2727
How it works:
2828

docs/tools/docker/docker.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,17 @@ The image is built and tested for the following architectures:
1919

2020
### Selecting the appropriate Docker tag
2121

22-
The Docker images are built, tested and published by GitHub Actions. When using the Docker image, make sure you are using the appropriate Docker tag that is compatible with Mbed OS version of your project. [Design document](https://github.com/ARMmbed/mbed-os/tree/master/docs/design-documents/docker_management) contains the detailed explanation of Docker image versioning strategy.
22+
The Docker images are built, tested and published by GitHub Actions. When using the Docker image, make sure you are using the appropriate Docker tag that is compatible with the Mbed OS version of your project. [Design document](https://github.com/ARMmbed/mbed-os/tree/master/docs/design-documents/docker_management) contains a detailed explanation of Docker image versioning strategy.
2323

24-
As a quick overview, use `ghcr.io/armmbed/mbed-os-env:mbed-os-6-latest` for Docker image compatible with released version of Mbed OS, or `ghcr.io/armmbed/mbed-os-env:latest` for Docker image compatible with `HEAD` of Mbed OS `master branch`.
24+
As a quick overview, use `ghcr.io/armmbed/mbed-os-env:mbed-os-6-latest` for a Docker image compatible with the released version of Mbed OS, or `ghcr.io/armmbed/mbed-os-env:latest` for a Docker image compatible with `HEAD` of Mbed OS `master branch`.
2525

2626
### Command line
2727

28-
The Mbed OS Docker container can be used using Docker Desktop on any supported platform (Windows, Linux & Mac).
28+
The Mbed OS Docker container can be used via Docker Desktop on any supported platform (Windows, Linux, and Mac).
2929

3030
#### Examples
3131

32-
Run interactively in current directory and compile the current application:
32+
Run interactively in the current directory and compile the current application:
3333

3434
```
3535
git clone https://github.com/ARMmbed/mbed-os-example-blinky.git && cd mbed-os-example-blinky
@@ -40,11 +40,11 @@ mbed-tools deploy
4040
mbed-tools compile -t GCC_ARM -m DISCO_L475VG_IOT01A
4141
```
4242

43-
<span class="tips">**Tip:** When building the Mbed OS project inside Docker container with shared workspace from Docker host, there could be performance issues as the filesystem needs to be synced between Docker host and container. For better performance ensure `gRPC FUSE for file sharing` [is enabled in Docker settings](https://www.docker.com/blog/deep-dive-into-new-docker-desktop-filesharing-implementation/).</span>
43+
<span class="tips">**Tip:** When building the Mbed OS project inside a Docker container with a shared workspace from Docker host, there could be performance issues as the filesystem needs to be synced between the Docker host and container. For better performance ensure `gRPC FUSE for file sharing` [is enabled in Docker settings](https://www.docker.com/blog/deep-dive-into-new-docker-desktop-filesharing-implementation/).</span>
4444

4545
### Continuous integration
4646

47-
We are in the process of moving our CI to use the GitHub Actions, and this can provide a great basis for your own CI for your Mbed-based projects.
47+
We are in the process of moving our CI to use GitHub Actions, and this can provide a great basis for your own CI for your Mbed-based projects.
4848

4949
#### Examples
5050

@@ -55,19 +55,19 @@ For a real-life example you can check out the [GitHub Actions workflow](https://
5555

5656
### Running GreenTea against USB devices in Docker Container
5757

58-
There are various limitations with connecting USB devices to a Docker container. Depending on the host machines, complexity to setup such environment will vary. On Mac, you will need to capture the device first in the underlying VM.
58+
There are various limitations with connecting USB devices to a Docker container. Depending on the host machines, the complexity to setup such environment will vary. On Mac, you will need to capture the device first in the underlying VM.
5959

6060
For this reason, running GreenTea from the Docker container is not trivial at the moment! We will be looking at future-proof solutions.
6161

62-
Having said that, if you are running Docker container in Linux host machine, you will be able to connect and run GreenTea tests by following these steps:
62+
Having said that, if you are running a Docker container on a Linux host machine, you will be able to connect and run GreenTea tests by following these steps:
6363

6464
```bash
6565
git clone https://github.com/ARMmbed/mbed-os && cd mbed-os
6666
sudo docker run -it --privileged -v "$(pwd)":/var/mbed -v /dev/disk/by-id:/dev/disk/by-id -v /dev/serial/by-id:/dev/serial/by-id -v /run/udev:/run/udev:ro -w /var/mbed ghcr.io/armmbed/mbed-os-env
6767
```
6868

69-
Then you will have a container with an Mbed OS development environment.
70-
To make sure your Mbed targets have been detected, you might want to manually run the mount command and `mbedls` to check
69+
You will then have a container with an Mbed OS development environment.
70+
To make sure your Mbed targets have been detected, you might want to manually run the mount command and `mbedls` to check:
7171

7272
```bash
7373
mount /dev/sdb /mnt

0 commit comments

Comments
 (0)