[PC-1033] Portenta X8: How To Build a Custom Image for Your Portenta X8 Redefinition (#359)

* Initial commit - Tutorial content update

* Tutorial content minor update

* Tutorial content update

Author: TaddyHC

content/hardware/04.pro/boards/portenta-x8/tutorials/image-building/content.md

@@ -1,7 +1,7 @@
 ---
 beta: true
 title: 'How To Build a Custom Image for Your Portenta X8'
-description: 'This tutorial teaches you how to compile a custom image for your Portenta X8'
+description: 'This tutorial teaches you how to compile a custom image for your Portenta X8.'
 difficulty: advanced
 tags:
   - Embedded Linux
@@ -14,24 +14,24 @@ hardware:
 
 ## Overview
 
-In this tutorial you will learn how to build an image for the Portenta X8 with the source code provided at our [GitHub repository for lmp-manifest](https://github.com/arduino/lmp-manifest).
-Building your image locally can help debug certain aspects of the system, such as the bootloader or kernel support.
+In this tutorial, you will learn how to build an image for the Portenta X8 with the source code provided at our [GitHub repository for lmp-manifest](https://github.com/arduino/lmp-manifest). Building your image locally can help debug several aspects of the system, such as the bootloader or kernel support.
 
-***Keep in mind that images built locally cannot register with FoundriesFactory and will not be OTA compatible, but this is a good alternative for those who do not have a FoundriesFactory subscription.
-This tutorial targets customers that are not FoundriesFactory subscribers, but still want to extend the functionality of the Arduino pre-built sources by building their own images. For FoundriesFactory subscribers, we strongly suggest making use of your Factory's continuous integration system for creating images.***
+***Images built locally cannot register with FoundriesFactory and will not be OTA compatible, but this is a good alternative for those who do not have a FoundriesFactory subscription.***
+
+This tutorial targets customers that are not FoundriesFactory subscribers, but still want to extend the functionality of the Arduino pre-built sources by building their images. For FoundriesFactory subscribers, we strongly suggest making use of your Factory's continuous integration system for image creation.
 
 ## Goals
 
-- Build a "builder" Docker image
-- Get the required files
-- Configure the build settings
-- Build the image
-- Save the needed files for flashing
+- Learn how to build a "builder" Docker image
+- Learn how to get the required files
+- Learn how to configure the build settings
+- Learn how to build the image
+- Learn how to save the needed files for flashing
 
 ### Required Hardware and Software
 
-- [Docker Engine](https://docs.docker.com/engine/install/)
 - [Arduino Portenta X8](https://store.arduino.cc/products/portenta-x8)
+- [Docker Engine](https://docs.docker.com/engine/install/)
 - ~60GB available space on your machine's drive
 
 ## Instructions
@@ -40,108 +40,124 @@ This tutorial targets customers that are not FoundriesFactory subscribers, but s
 
 #### Build the Docker Image
 
-You will create a Docker image that has the dependencies needed to build your device image.
+You will create a Docker image that has the dependencies needed to build your device image. To do so, you will need to clone our [lmp-manifest repository](https://github.com/arduino/lmp-manifest). The following steps will guide you through the process:
 
-To do so you will need to clone our [lmp-manifest repository](https://github.com/arduino/lmp-manifest), follow these steps to do so:
+First, clone the lmp-manifest repository with the following command:
 
-First, clone the lmp-manifest repository with this command:
-  ```
-  git clone https://github.com/arduino/lmp-manifest.git
-  ```
-  ![Cloning lmp-manifest repository](assets/git_clone_lmp-manifest.png)
+```
+git clone https://github.com/arduino/lmp-manifest.git
+```
 
-Then build the Docker Image using:
-  ```
-  cd lmp-manifest
-  docker build -t yocto-build ./lmp-manifest
-  ```
-  ![Building a Docker Image](assets/docker_build.png)
+![Cloning lmp-manifest repository](assets/git_clone_lmp-manifest.png)
+
+After cloning the lmp-manifest repository successfully, we will proceed to build the Docker Image using following command sequence:
+
+```
+cd lmp-manifest
+docker build -t yocto-build ./lmp-manifest
+```
+
+![Building a Docker Image](assets/docker_build.png)
+
+You will be able to see similar result if everything went successfully.
 
 #### Run The Docker Image (Builder)
 
-Run the image with the `-v` argument to mount a volume. This allows you to use a host directory inside the Docker image, so you can store all the data and build artifacts safely.
+Once the *Docker Image* is ready, we will run the image with the `-v` argument to mount a volume. This allows you to use a host directory inside the Docker image, so you can store all the data and build artifacts safely.
 
 ***If you do not use a volume while running the image, you will lose the data when the image stops***
 
-Run the `yocto-build` builder image with:
+Run the `yocto-build` builder image with following command:
+
 ```
 docker run -v <source>:/dockerVolume -it yocto-build bash
 ```
 
-Switch to the `builder` user with the following command, the password is **builder**:
+We need to switch to the `builder` user with the following command after the previous process, and the password is **builder**:
+
 ```
 su builder
 ```
 
-### Setup and Build
+### Image Setup and Build
 
 ***You can download a [bash script](assets/portenta-x8_build.sh) that wraps all the upcoming steps.***
 
 #### Setup the Environment
 
 Now that you are running inside the Docker Image, you can use tools like **git-repo**, which is already installed.
 
-First configure git with your credentials. They don't need to be the real ones, but are required by `git-repo` to pull.
-Copy and paste the following:
+First, configure git with your credentials. They don't need to be the real ones but are required by `git-repo` to pull. The following commands can be used for this example:
+
 ```
 git config --global user.email "you@example.com"
 git config --global user.name "Your Name"
 ```
+
 ![Adding credentials to git config](assets/git_config.png)
 
 Change to the home directory, and initialize the repository using **repo**:
+
 ```
 cd ~
 repo init -u https://github.com/arduino/lmp-manifest.git -m arduino.xml -b release
 ```
+
 ![Git-repo initialization](assets/repo_init.png)
 
 Then pull the needed files with:
+
 ```
 repo sync
 ```
+
 ![Git-repo pulling all the repositories](assets/repo_sync.png)
 
-After completion it should look like the following image:
+After completion, it should look like the following image:
 
 ![Git-repo finished sync](assets/repo_sync_finished.png)
 
 ***NOTE: If you are a FoundriesFactory subscriber and want to build your Factory sources locally, please use the manifest link for your Factory as below. This is not recommended as images built locally cannot register to the Factory and receive OTAs.***
 
-#### Set Up The Portenta X8 Distribution
+#### Set Up the Portenta X8 Distribution
 
-You can set `DISTRO` to:
-- `lmp-base`: insecure image without ostree, developer friendly, not OTA compatible
+It is recommendable to set `DISTRO` to either:
+
+- `lmp-base`: insecure image without ostree, developer-friendly, not OTA compatible
 - `lmp`: secure image without xwayland
 - `lmp-xwayland`: secure image with xwayland support
 
-***`lmp-partner-arduino-image` will be better supported in the near future.***
+It will help to classify the image if it follows any of the previous characteristics and with the following command:
 
 ```bash
 DISTRO=lmp-xwayland MACHINE=portenta-x8 . setup-environment
 ```
 
-It will then switch automatically to a new folder. Now to accept the EULA with:
+***`lmp-partner-arduino-image` will be better supported soon.***
+
+It will then switch automatically to a new folder. Continuing, you can now proceed to accept the EULA using the following command:
 
 ```bash
 echo "ACCEPT_FSL_EULA = \"1\"" >> conf/local.conf
 ```
 
+You will be able to see similar output as following after the previous steps:
+
 ![Setup Portenta X8 DISTRO](assets/x8_distro_setup.png)
 
-#### Build Image With Bitbake
+#### Build an Image With Bitbake
 
-To start building the image, run:
+To start building the image, following command is used:
 
 ```
 bitbake lmp-partner-arduino-image
 ```
-***This process takes ~7h depending on the build host***
+
+***This process may take ~7 hours depending on the build host***
 
 ![Compile Portenta X8 image](assets/x8_build.png)
 
-In case you want to use your computer while it builds, (which is going to take time and resources) you should lower the threads used.
-Do so by opening `conf/local.conf` and lower the values of the following variables:
+If you want to use your computer while it builds, it is recommendable to lower the threads used since it takes a lot of resources and time. Do so by opening `conf/local.conf` and lowering the values of the following variables:
 
 - `BB_NUMBER_PARSE_THREADS = "4"`
 - `BB_NUMBER_THREADS = "4"`
@@ -150,36 +166,44 @@ And add:
 
 - `PARALLEL_MAKE = "-j 4"`
 
-Once it finishes you will see something similar to:
+If possible, it is a good practice to understand the available threads of your computer used for this process, to optimize the resources accordingly for optimal balance between build performance and side tasks while waiting for the build. Once it finishes you will see something similar to:
+
 ![Portenta X8 Image finished compilation](assets/x8_build_finished.png)
 
 #### Setup Manufacturing Tools
 
-To flash your board you will need to compile **lmp-mfgtool distro** to get additional tools. First go into your home folder and change `DISTRO`:
+To flash your board, you will need to compile **lmp-mfgtool distro** to get additional tools. First, go into your home folder and change `DISTRO` following the command sequence:
+
 ```
 cd ..
 DISTRO=lmp-mfgtool MACHINE=portenta-x8 . setup-environment
 echo "ACCEPT_FSL_EULA = \"1\"" >> conf/local.conf
 echo "MFGTOOL_FLASH_IMAGE = \"lmp-partner-arduino-image\"" >> conf/local.conf
 ```
+
+You should be able to see similar results as following image when successful:
+
 ![Flashing tools DISTRO setup](assets/tools_distro_setup.png)
 
 #### Build Manufacturing Tools: Flash The Board
 
-To compile and get the tools you will need to type:
+To compile and get the tools required, we will use following command:
+
 ```
 bitbake mfgtool-files
 ```
+
 ![Compiling flashing tools](assets/tools_build.png)
 
 After completion:
+
 ![Tools compilation finished](assets/tools_finished.png)
 
-***This process takes ~2h depending on your build host***
+***This process may take ~2 hours depending on your build host***
 
 #### Save Your Image For Flashing
 
-After a successful build,  save the needed files to the host volume you mounted with `docker run`. Use the following commands to copy the files to your storage unit:
+After a successful build, save the needed files to the host volume you mounted with `docker run`. Use the following commands to copy the files to your storage unit:
 
 ```
 cd ..
@@ -199,15 +223,16 @@ tar xvf mfgtool-files-portenta-x8.tar.gz
 ![Copying compiled files](assets/copy_files.png)
 
 You will be able to see the copied files in your OS file explorer.
-![Checking copied files with file explorer](assets/docker_volume_explorer.png)
 
+![Checking copied files with file explorer](assets/docker_volume_explorer.png)
 
 ## Conclusion
 
-Now you have all the required files to flash the image you built onto the device.
+In this tutorial, you have learned how to build a "builder" Docker image, get its required files, configure the build settings, build the image,a and to save the needed files for flashing. Now you have all the required files to flash the image you built onto the device.
+
+## Next Steps
 
-Please follow the [Flashing tutorial](image-flashing) to flash your device with your custom image.
-Keep in mind you will need to use the files provided from this build, not the ones mentioned in the Flashing tutorial.
+Please follow the [Flashing tutorial](image-flashing) to flash your device with your custom image. You can use the files provided from this build to flash the Portenta X8 following the tutorial's steps.
 
 ## Troubleshooting