From 614b5caa5836f17eb0199bca135e34fe3767140e Mon Sep 17 00:00:00 2001
From: Patrick Vogelaar <patrick.vogelaar@belden.com>
Date: Wed, 9 Nov 2022 06:50:04 +0100
Subject: [PATCH] Update documentation

* Fix typos
* CoreOS was added by git clone but should be added as submodule -> fixed it
---
 documentation/using-coreos.rst | 29 ++++++++++++++---------------
 1 file changed, 14 insertions(+), 15 deletions(-)

diff --git a/documentation/using-coreos.rst b/documentation/using-coreos.rst
index 27c24d2..160a03e 100644
--- a/documentation/using-coreos.rst
+++ b/documentation/using-coreos.rst
@@ -2,12 +2,12 @@
 Setting up a CoreOS based distro
 ********************************
 
-This chapter explain how to setup a distro based in CoreOS
+This chapter explains how to setup a distro based on CoreOS.
 
 Repository structures
 #####################
 
-OpenEmbedded is a flexible tools, but we encourage each of our users to adopt
+OpenEmbedded is a flexible tool, but we encourage each of our users to adopt
 the same structure as CoreOS. In this chapter, replace each usage of `PRODUCT`
 or `product` by a unique name related to your product.
 
@@ -46,10 +46,9 @@ Creating the structures
     ~/product$ mkdir layers
     ~/product$ mkdir scripts
 
-    ~/product$ cd layers
-    ~/product/layers$ git clone --recurse-submodules ssh://git@bitbucket.gad.local:7999/ico/coreos.git
+    ~/product$ git submodule add -b <branch> ssh://git@bitbucket.gad.local:7999/ico/coreos.git layers/coreos
+    ~/product$ git submodule update --init --recursive
 
-    ~/product/layers$ cd ..
     ~/product$ cp -r layers/coreos/templates ./templates
     ~/product$ cp layers/coreos/.gitignore ./.gitignore
 
@@ -59,13 +58,13 @@ Creating the structures
 
 .. note::
 
-    By copying the .gitignore file of CoreOS, the build directory of the product
-    will not be stored inside of Git, which is the recommended approach as using
-    `devtool modify` modify the local `bblayers.conf`. Instead we recommend to
+    By copying the .gitignore file of CoreOS, the build directory in the the product
+    repository will not be tracked by Git, which is the recommended approach as using
+    `devtool modify` modifies the local `bblayers.conf`. Instead we recommend to
     keep the template directory up to date so that a sane configuration can be
     created when fetching the repository for the first time.
 
-Then you can enter the following inside the product-init-build-env files
+Then you can enter the following inside the product-init-build-env file:
 
 .. code-block:: sh
 
@@ -105,7 +104,7 @@ Then you can enter the following inside the product-init-build-env files
     # Add the scripts directory of the product to the path
     coreos_path_add "${PRODUCT_ROOT}/scripts"
 
-Using you new projects
+Using your new project
 ######################
 
 .. code-block:: sh
@@ -115,7 +114,7 @@ Using you new projects
 Creating your product layers
 ############################
 
-You can create a new layers and add it to your active bblayers.conf file like
+You can create a new layer and add it to your active bblayers.conf file like
 this:
 
 .. code-block:: sh
@@ -143,7 +142,7 @@ Create your own distro based on CoreOS
 ######################################
 
 Create a new file inside configuration file inside
-`product/layers/meta-product/conf/distro`. For a distro named, you will create
+`product/layers/meta-product/conf/distro`. For a distro named `product`, you will create
 `product/layers/meta-product/conf/distro/product.conf`.
 
 Open this file and enter the following:
@@ -155,7 +154,7 @@ Open this file and enter the following:
     require conf/distro/belden-coreos.conf
 
     # This should always be set in your own configuration file, to not use the
-    # value of CoreOS
+    # values of CoreOS
     DISTRO = "product"
     DISTRO_NAME = "Product Linux Distribution"
     MAINTAINER = "Belden Product Team"
@@ -165,8 +164,8 @@ Open this file and enter the following:
     DISTRO_VERSION = "2022.05"
     DISTRO_CODENAME = "ProductOS Summer 2022 Edition"
 
-    # From here you can overrides settings from the CoreOS distro or from
-    # OpenEmbedded-core. But keep in mind that the CoreOS teams doesn't support
+    # Here you can override settings from the CoreOS distro or from
+    # OpenEmbedded-core. But keep in mind that the CoreOS team doesn't support
     # all the features of OpenEmbedded-Core. We have added some checks for some
     # of the settings that we don't allow to change or that we don't support.
     # See the coreos-sanity.bbclass file for more info.