From 6e65419e574d1ec12478a38c3138bc3324325ff0 Mon Sep 17 00:00:00 2001
From: sailajakommineni <sailaja.kommineni@accenture.com>
Date: Thu, 30 Nov 2023 13:41:06 +0000
Subject: [PATCH] feat(shared): Implement GitHub Spellcheck and grammar linting
 for Pull request.

This pull request implements the GitHub Spellcheck feature to automatically check the spelling and grammar in commit messages for all Pull Requests (PRs).

Changes Made:
- modified the code to check the grammar errors at exact line numbers.
-In docs/README.md file corrected the grammar errors.

Fixes: #2327

Signed-off-by: sailajakommineni <sailaja.kommineni@accenture.com>
---
 .github/.wordlist.txt                | 128 +++++++++++++++++++++++++++
 .github/workflows/grammarcheck.yaml  |  73 +++++++++++++++
 .github/workflows/spellcheck.yaml    |  51 ++---------
 docs/README.md                       |  35 ++++----
 docs/source/compatibilitytable.md    |   2 +-
 docs/source/contributing.md          |   8 +-
 docs/source/faq.md                   |  30 +++----
 docs/source/glossary.md              |  30 +++----
 docs/source/introduction.md          |  10 +--
 docs/source/prerequisites.md         |   6 +-
 docs/source/prerequisites_machine.md |   4 +-
 11 files changed, 270 insertions(+), 107 deletions(-)
 create mode 100644 .github/workflows/grammarcheck.yaml

diff --git a/.github/.wordlist.txt b/.github/.wordlist.txt
index 2c27005a337..52455bba435 100644
--- a/.github/.wordlist.txt
+++ b/.github/.wordlist.txt
@@ -41,3 +41,131 @@ py
 md
 pre
 html
+http
+www
+rst
+toctree
+reStructuredText
+DCO
+UI
+Blockchain
+DigitalOcean
+GCP
+repo
+APIs
+readme
+https
+EKS
+yaml
+microservices
+Modularity
+Scalability
+readthedocs
+roadmap
+Jira
+CLI
+ansible
+kubectl
+gitops
+CRD
+CustomResourceDefinition
+fluxcd
+github
+TBD
+trainings
+HashiCorp
+upto
+HelmRelease 
+hackathon
+Hashicorp
+Authenticator
+JSON
+ajv
+cli
+npm
+NPM
+MacOS
+jq
+openshift
+Homebrew
+validator
+blockchain
+GitOps
+VM
+backend
+DNS
+HAProxy
+POC
+dev
+url
+cryptographically
+BaaS
+OpenShift
+BYOI
+architected
+TCP
+scalable
+MSP
+SDK
+MSPs
+kubeconfig
+TLS
+PV
+RPC
+CorDapps
+JVM
+CA’s
+PKI
+KUBECONFIG
+DDO
+DIDs
+NYM
+rpc
+MTA
+memcached
+auditable
+config
+IAM
+IOT
+IoT
+kubelet
+Kubeconfig
+PersistentVolume
+lifecycle
+cryptographic
+decrypting
+SCM
+SHA
+Brandl
+Georg
+LDAP
+Chaincode
+chaincode
+subnet
+Orderer
+permissioned
+Zkkafka
+zkkafka
+servlet
+CA’s
+NetworkMap
+Networkmap
+interoperable
+merkle
+Verinym
+Sovrin
+Prover
+Anonym
+DKMS
+Enode
+privateFor
+Ethereum
+geth
+pluggable
+Hostnames
+crypto
+parallelization
+kube
+PV's
+CorDapp
+storageclass
diff --git a/.github/workflows/grammarcheck.yaml b/.github/workflows/grammarcheck.yaml
new file mode 100644
index 00000000000..0dbea3daaf8
--- /dev/null
+++ b/.github/workflows/grammarcheck.yaml
@@ -0,0 +1,73 @@
+---
+name: grammer check
+on:
+  workflow_dispatch:
+    inputs:
+      grammar_check_disabled:
+        description: 'Disable grammar check'
+        default: 'false'
+        required: false
+  push:
+    branches:
+    - "**"
+  pull_request:
+    paths:
+      - 'docs/*.md'
+    types: [opened, edited, updated]          
+
+env:
+  GRAMMAR_CHECK_DISABLED: ${{ github.event.inputs.grammar_check_disabled || 'false' }}
+
+jobs:
+  check-grammar:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.8
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+    # Install the dependencies for grammer check 
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip setuptools
+        pip install --user --upgrade language_tool_python
+
+    # To check the grammatical mistakes of the given files and folders.
+    - name: Run grammar check
+      if: ${{ env.GRAMMAR_CHECK_DISABLED == 'false' }}
+      run: |
+        python - <<EOF
+        import language_tool_python
+
+        # Initialize LanguageTool
+        tool = language_tool_python.LanguageTool('en-US')  # You can specify the language you want to check.
+
+        # Specify the directory path
+        directory_path = 'docs'
+
+        # Read the text from your file 
+        file_path = 'docs/*.md'  # Update the path accordingly
+        with open(file_path, 'r', encoding='utf-8') as file:
+            text = file.read()
+
+        # Check for grammar errors
+        matches = tool.check(text)
+        
+        # Print relevant grammar errors with line numbers
+        relevant_errors = []
+        if matches:
+            for match in matches:
+                if match.ruleId == 'MORFOLOGIK_RULE_EN_US':
+                   line_number = text.count('\n', 0, match.offset) + 1
+                   relevant_errors.append((line_number, match.message))
+
+            if relevant_errors:
+                for error in relevant_errors:
+                    line_number, message = error
+                    print(f"Grammar error at line {line_number}: {message}")
+                exit(1)
+        else:
+            print("No grammar errors found.")
+            exit(0)
+        EOF
diff --git a/.github/workflows/spellcheck.yaml b/.github/workflows/spellcheck.yaml
index dc595921973..7c1b0472b32 100644
--- a/.github/workflows/spellcheck.yaml
+++ b/.github/workflows/spellcheck.yaml
@@ -1,20 +1,19 @@
 ---
-name: spell and grammer check
+name: spell check
 on:
   push:
     branches:
     - "**"
-  pull_request_target:
-    branches:
-    - "**"
+  pull_request:
+    paths:
+      - 'docs/*.md'
     types: [opened, edited, updated]          
 
 env:
   SPELL_CHECK_DISABLED: false
-  GRAMMAR_CHECK_DISABLED: false
 
 jobs:
-  check-spelling-and-grammar:
+  check-spelling:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
@@ -22,52 +21,18 @@ jobs:
       uses: actions/setup-python@v2
       with:
         python-version: 3.8
-    # Install the dependencies for grammer check and spell check.
+    # Install the dependencies for spell check.
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip setuptools
         python -m pip install pyspelling 
         sudo apt-get install hunspell hunspell-en-us aspell aspell-en
-        pip install --user --upgrade language_tool_python
-      
+        
     - uses: actions/checkout@v2
     - name: Spellcheck
       if: ${{ env.SPELL_CHECK_DISABLED == 'false' }}
       uses: rojopolis/spellcheck-github-actions@0.34.0
       with:
         config_path: .github/.spellcheck.yaml
-        source_files: "docs/README.md"       # name of the file to check spell 
+        source_files: 'docs/*.md'       # name of the file to check the spell 
         task_name: Markdown
-    # To check the grammatical mistakes of the given files and folders.
-    - name: Run grammar check
-      if: ${{ env.GRAMMAR_CHECK_DISABLED == 'false' }}
-      run: |
-        cat <<EOF | python -
-        import language_tool_python
-
-        # Initialize LanguageTool
-        tool = language_tool_python.LanguageTool('en-US')  # You can specify the language you want to check.
- 
-        # Specify the directory path
-        directory_path = 'docs'
-
-        # Read the text from your file
-        file_path = 'docs/README.md'  # Update the path accordingly
-        with open(file_path, 'r', encoding='utf-8') as file:
-            text = file.read()
- 
-        # Check for grammar errors
-        matches = tool.check(text)
- 
-        # Print grammar errors with line numbers
-        if matches:
-            for match in matches:
-                print(f"Grammar error at line {match.offset} - {match.message}")
-            # Exit with a non-zero code to indicate failure
-            exit(1)
-        else:
-            # No grammar errors found, print a success message
-            print("No grammar errors found.")
- 
-            exit(0)
-        EOF
diff --git a/docs/README.md b/docs/README.md
index c2cb7dca887..6f3b8322422 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,41 +1,38 @@
 # Docs
 ## About
-This directory contains the files required to create open source documentation.
-Tools used: [Sphinx](http://www.sphinx-doc.org/)
-### Configuration files
-* **Index.rst** - This is the main document. Main function of this document is to serve as a welcome page, and to contain the root of the “table of contents tree” (or toctree).This is one of the main things that Sphinx adds to reStructuredText, a way to connect multiple files to a single hierarchy of documents
-* **conf.py** -  The configuration directory must contain a file named conf.py. This file (containing Python code) is called the “build configuration file” and contains (almost) all configuration needed to customize Sphinx input and output behavior.
-* **.md files** - Create all the markdown file which are referenced in the document tree with the appropriate content.
+This directory contains the files required to create open-source documentation.
+Tools used: [Sphinx] (http://www.sphinx-doc.org/).
+## Configuration files
+* **index.rst** - This is the main document. This is one of the main things that Sphinx adds to restructured text: a way to connect multiple files to a single hierarchy of documents, including the 'table of contents tree'(or toctree).
+* **conf.py**: The configuration directory must contain a file named conf.py. This file (containing Python code) is called the “build configuration file” and contains (almost) all the configuration needed to customize Sphinx input and output behavior.
+* **.md files**: Create all the markdown files that are referenced in the document tree with the appropriate content.
 
 ```
 ./
 ├── docs
 │   ├── source
-│   │     ├── index.rst
-│   │     ├── conf.py
-│   │     ├── *.md
+|   |   |── index.rst
+│   │   ├── conf.py
+│   │   ├── *.md
 │   ├── Makefile
-|   ├── pip-requirements.txt
+|   ├── pip-requirements.txt
 │   └── README.md
 ├── CONTRIBUTING.md
 ```
 
 ### Building the docs
-1. Install latest sphinx
+1. Install the latest Sphinx.
 ```
 pip install -U Sphinx
 ```
-2. Install the pre-requisites
+2. Install the prerequisites.
 ```
 pip install -r pip-requirements.txt
 ```
-3. Build the documents
+3. Build the documents.
 ```
-make html
+make HTML
 or
-make.bat html
+make.bat HTML
 ```
-4. Access the documents from **build/html/** folder.
-
-
-
+4. Access the documents from the **build/html** folder.
diff --git a/docs/source/compatibilitytable.md b/docs/source/compatibilitytable.md
index e2c51172614..56694a4f449 100644
--- a/docs/source/compatibilitytable.md
+++ b/docs/source/compatibilitytable.md
@@ -5,7 +5,7 @@
 
 # Compatibility Table
 Bevel current tools/platforms support version and historic details 
-## Colour Legends
+## Color Legends
 ![](./_static/legends.png)
 ## Compatibility Table
 ![](./_static/compatibility_table.png)
diff --git a/docs/source/contributing.md b/docs/source/contributing.md
index e222c0d875d..54d433e0f26 100644
--- a/docs/source/contributing.md
+++ b/docs/source/contributing.md
@@ -12,7 +12,7 @@ there's always plenty to do!
 
 First things first, please review the [Hyperledger Code of Conduct](https://wiki.hyperledger.org/display/HYP/Hyperledger+Code+of+Conduct) before participating and please follow it in all your interactions with the project.
 
-You can contibute to Bevel, as a user or/and as a developer.
+You can contribute to Bevel, as a user or/and as a developer.
 
 ##### As a user:
 
@@ -23,7 +23,7 @@ You can contibute to Bevel, as a user or/and as a developer.
 
 Consider picking up a [“help-wanted”](https://github.com/hyperledger/bevel/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22) or ["good-first-issue"](https://github.com/hyperledger/bevel/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) task  
 
-If you can commit to full-time/part-time development, then please contact us on our [Rocketchat channel](https://chat.hyperledger.org/channel/bevel ) to work through logistics!
+If you can commit to full-time/part-time development, then please contact us on our [Rocket chat channel](https://chat.hyperledger.org/channel/bevel ) to work through logistics!
 
 Please visit the
 [Developer Guide](developerguide.md) in the docs to learn how to make contributions to this exciting project.
@@ -41,11 +41,11 @@ For source code integrity , Hyperledger Bevel GitHub pull requests are accepted
 5. Push your changes to your feature branch
 6. Initiate a pull request from your fork to the base repository ( develop branch , unless it is a critical bug, in that case initiate to the main branch)
 7. Await DCO & linting quality checks ( CI to come soon ), as well as any feedback from reviewers.
-8. Work on the feedbacks to revise the PR if there are any comments
+8. Work on the feedback to revise the PR if there are any comments
 9. If not, the PR gets approved , delete feature branch post the merge
 
 ---
-**NOTE:** If you are a regular contributor , please make sure to take the latest pull from the develop branch everytime before making any pull request , main branch in case of a critical defect / bug .
+**NOTE:** If you are a regular contributor , please make sure to take the latest pull from the develop branch every time before making any pull request , main branch in case of a critical defect / bug .
 
 ---
 
diff --git a/docs/source/faq.md b/docs/source/faq.md
index f8d0cd83d56..9d4ec2adc4d 100644
--- a/docs/source/faq.md
+++ b/docs/source/faq.md
@@ -9,31 +9,31 @@ Frequently Asked Questions
 ## 1.FAQs for Getting Started
 
 ### Who are the target users?
-In this project, it is assumed that a user would fall into either a category of [Operators](./operationalguide.md) or [Developers](./developerguide.md). However, this is not saying that technicians such as Solution/Tech Archs who have more expertise in wider areas are not eligible users, e.g. Blockchain or Distributed Ledger Technology (DLT). On the contrary, a user who has proper technical knowledge on those areas will find the usage of Hyperledger Bevel  repository mentioned in the tutorial on this website to be more straightforward. For people new to these areas, they might find a deep learning curve before using or even contributing back to this repository. If a user is from a non-tech background, but would still like to find out how Bevel could accelerate set-up of a new production-scale DLT network, the [Introduction](./introduction.md) section is the right start point.
+In this project, it is assumed that a user would fall into either a category of [Operators](./operationalguide.md) or [Developers](./developerguide.md). However, this is not saying that technicians such as Solution/Tech Arch's who have more expertise in wider areas are not eligible users, e.g.Blockchain or Distributed Ledger Technology (DLT). On the contrary, a user who has proper technical knowledge on those areas will find the usage of Hyperledger Bevel  repository mentioned in the tutorial on this website to be more straightforward. For people new to these areas, they might find a deep learning curve before using or even contributing back to this repository. If a user is from a non-tech background, but would still like to find out how Bevel could accelerate set-up of a new production-scale DLT network, the [Introduction](./introduction.md) section is the right start point.
 
 (1) **Operators**:
 An operator is a System Operator that would work as a Deployment Manager, who has strong technical knowledge on cloud architecture and DevOps but basic DLT. An operator might be a decision maker in a new DLT/Blockchain project, and would be responsible for the ongoing stability of the organization's resources and services as well as set-up and maintenance of one or more applications for the organization. 
 
 A **common scenario** that an operator would like to leverage Hyperledger Bevel repository might be that s/he has been asked to use a DLT/Blockchain technology for a business case, but s/he does not know where/how to start. S/he might have limited budget, and might not have all the technical skills in the team and was overwhelmed by the time it would take for the solution to be created. 
 
-**Unique values** in scenarios like this provisioned by Hyperledger Bevel repository are: (a) efficiency and rapid deployment (b) consistent quality (c) open-source (d) cloud infrastructure independence (e) optimization via scalability, modularity and security and (f) accelerated go-to-market. 
+**Unique values** in scenarios like this provisioned by Hyperledger Bevel repository are: (a) efficiency and rapid deployment (b) consistent quality (c) open-source (d) cloud infrastructure independence (e) Optimization via Scalability, Modularity and security, and (f) accelerated go-to-market. 
 
-Essentially, an operator would be able to set up a large-size DLT/Blockchain network in a production environment by using this repository as per the tutorials in this website along with the instructions in the readme files in the repository. The network requirements such as which DLT/Blockchain platform (e.g. Fabric/Corda) and which cloud platform (e.g. AWS/GCP/Azure/DigitalOcean etc) would be used should have been pre-determined already before using this repository. The operator would ensure that Hyperledger Bevel repo is set up and deployed properly. Eventually, Bevel would speed up the whole DLT/Blockchain network set-up process and would require less DLT/Blockchain developers enabling the operator to retain the budgets and man-power for other activities. 
+Essentially, an operator would be able to set up a large-size DLT/Blockchain network in a production environment by using this repository as per the tutorials in this website along with the instructions in the readme files in the repository. The network requirements such as which DLT/Blockchain platform (e.g. Fabric/Corda) and which cloud platform (e.g.,AWS/GCP/Azure/DigitalOcean,etc) would be used should have been pre-determined already before using this repository. The operator would ensure that Hyperledger Bevel repo is set up and deployed properly. Eventually, Bevel would speed up the whole DLT/Blockchain network set-up process and would require less DLT/Blockchain developers enabling the operator to retain the budgets and man-power for other activities. 
 
 (2) **Developers**:
 A developer can be a DevOps or Full Stack Developer who would have knowledge on multiple programming languages, basic knowledge of DLT/Blockchain networks and smart contracts, Ansible and DevOps. Daily work might include developing applications and using DevOps tools. 
 
-A **common scenario** that a developer would like to use this repo might be that s/he would like to gain knowledge on production-scale DLT/Blockchain development, but might not have enough technical skills and experiences yet. Learing knowledge from the existing poorly-designed architecture would be time-consuming and fruitless.
+A **common scenario** that a developer would like to use this repo might be that s/he would like to gain knowledge on production-scale DLT/Blockchain development, but might not have enough technical skills and experiences yet. Learning knowledge from the existing poorly-designed architecture would be time-consuming and fruitless.
 
-Hyperledger Bevel provisions its **unique values** to the developer that s/he now has an opportunity to learn how different sets of cutting-edge technologies leveraged in this repository are combined in use such as reusable architecture patterns, reusable assets including APIs or microservices design. The architecture design in this repository has been fully tested and demonstrated as a high-quality one known for a fact that it has been being improved continously through the technical experts' rich experiences. The developer could try to use this repository to set up a small-size DLT/Blockchain network to see how it works and gradually pick up new skills across Blockchain, DevOps, etc.
+Hyperledger Bevel provisions its **unique values** to the developer that s/he now has an opportunity to learn how different sets of cutting-edge technologies leveraged in this repository are combined in use such as reusable architecture patterns, reusable assets including APIs or microservices design. The architecture design in this repository has been fully tested and demonstrated as a high-quality one known for a fact that it has been being improved continuously through the technical experts' rich experiences. The developer could try to use this repository to set up a small-size DLT/Blockchain network to see how it works and gradually pick up new skills across Blockchain, DevOps, etc.
 
-Furthermore, the developer could even show the maturity of skills to contribute back to this project. Contributions can include but not limited to (1) suggest or add new functionalities (2) fix various bugs and (3) organize hackthon or developer events for Hyperledger Bevel in the future.
+Furthermore, the developer could even show the maturity of skills to contribute back to this project. Contributions can include but not limited to (1) suggest or add new functionalities (2) fix various bugs and (3) organize hackathon or developer events for Hyperledger Bevel in the future.
 
 ### What is Hyperledger Bevel and how could it help me?
 In simple words, Hyperledger Bevel works as an accelerator to help organizations set up a production-scale DLT network (currently supports Corda, Fabric, Indy, Besu and Quorum) with a single network.yaml file used for [Fabric](./operations/fabric_networkyaml.md) or [Corda](./operations/corda_networkyaml.md) or [Quorum](./operations/quorum_networkyaml.md) to be configured in this project. It can work in managed Kubernetes Clusters which has been fully tested in AWS Elastic Kubernetes Services (EKS), and should also work in a non-managed Kubernetes Cluster in theory. For detailed information, please see the [Welcome page](index).
 
 ### How do I find more about Hyperledger Bevel?
-Normally, when a user sees information in this section, it means that s/he has already known the existence of Hyperledger Bevel project, at least this readthedocs website. Basically, this website provisions a high-level background information of how to use Hyperledger Bevel GitHub repository. For detailed step-by-step instructions, one should go to Hyperledger Bevel's GitHub repository and find the readme files for a further reading. Upon finishing reading the tutorials in this website, one should be able to analyse whether Hyperledger Bevel would be the right solution in your case and reach a decision to use it or not.
+Normally, when a user sees information in this section, it means that s/he has already known the existence of Hyperledger Bevel project, at least this readthedocs website. Basically, this website provisions a high-level background information of how to use Hyperledger Bevel GitHub repository. For detailed step-by-step instructions, one should go to Hyperledger Bevel's GitHub repository and find the readme files for a further reading. Upon finishing reading the tutorials in this website, one should be able to analyze whether Hyperledger Bevel would be the right solution in your case and reach a decision to use it or not.
 
 ### How much would Hyperledger Bevel cost? How much would it cost to run Hyperledger Bevel on a cloud platform?
 As an open source repository, there will be no cost at all to use Hyperledger Bevel. However, by running Hyperledger Bevel repository on a cloud platform, there might be cost by using a cloud platform and it will depend on which cloud services you are going to use.
@@ -44,11 +44,11 @@ One could raise questions in the Github repository and Hyperledger Bevel maintai
 ### Is there any training provided? If so, what kind of training will be included?
 Unfortunately, there are no existing training for using Hyperledger Bevel yet, because we are not sure about the potential size of the community and what types of training people would look forward to. However, we do aware that trainings could happen, if there would be a large number of same or similar questions or issues raised by new users, and if we would have a large amount of requests like this in the future.  
 
-### Can I add/remove one or more organisations as DLT nodes in a running DLT/Blockchain network by using Hyperledger Bevel?
+### Can I add/remove one or more organizations as DLT nodes in a running DLT/Blockchain network by using Hyperledger Bevel?
 Yes, you can add additional nodes to a running DLT/Blockchain network using Hyperledger Bevel . Unfortunately, Bevel does not support removing nodes in a running DLT/Blockchain network, but this significant feature is in our future roadmap, and we will add this feature in a future release.
 
 ### Does Hyperledger Bevel support multiple versions of Fabric and Corda? What are the minimum versions for Fabric and Corda supported in Hyperledger Bevel?
-Hyperledger Bevel currently only supports version 1.4.8 & 2.2.2 for Fabric and version 4.1 and 4.4 for Corda as minimum versions, and will only support future higher versions for Fabric and Corda. Corda Enterprise 4.7 is available as per latest release. Please check the [latest releases](https://github.com/hyperledger/bevel/releases) for version upgrades and deprecations.
+Hyperledger Bevel currently only supports version 1.4.8 & 2.2.2 for Fabric and version 4.1 and 4.4 for Corda as minimum versions, and will only support future higher versions for Fabric and Corda. Corda Enterprise 4.7 is available as per latest release. Please check the [latest releases](https://github.com/hyperledger/bevel/releases) for version upgrades and deprecation.
 
 ## 2.FAQs for Operators Guide
 
@@ -56,7 +56,7 @@ Hyperledger Bevel currently only supports version 1.4.8 & 2.2.2 for Fabric and v
 To run Hyperledger Bevel repository, you need to have a managed/non-managed Kubernetes clusters ready as well as an unsealed Hashicorp Vault service available. 
 
 ### What would be the recommended/required cloud service?
-We recommand to use Cloud Services such as Aamzon Web Services (AWS), Microsoft Azure, Google Cloud Platform (GCP) and DigitalOcean (DO) as their managed Kubernetes clusters services are being or will be tested for this repository. We have fully tested this repository in AWS, and testing it on Azure, GCP, DO is in our future roadmap.
+We recommend to use Cloud Services such as Amazon Web Services (AWS), Microsoft Azure, Google Cloud Platform (GCP) and DigitalOcean (DO) as their managed Kubernetes clusters services are being or will be tested for this repository. We have fully tested this repository in AWS, and testing it on Azure, GCP, DO is in our future roadmap.
 
 ### Do I have to use AWS? 
 No, AWS is not mandatory, but is recommended because it is the first cloud platform we have tested on. Theoretically, Hyperledger Bevel repository should work in any cloud platforms as long as a Kubernetes Cluster service is provisioned, but there is no 100% guarantee it will work, since there might be unseen/unknown features in these managed Kubernetes clusters environments we are not aware of.
@@ -74,13 +74,13 @@ Hyperledger Bevel repository relies a lot on using [Ansible](./gettingstarted.ht
 The network.yaml file is the main file to be configured to set up a DLT/Blockchain network. [This page](./operationalguide.md) gives the links for a user to pick up knowledge of how to configure this file for Fabric and Corda first (see the two "Configuration file specification" sections for each DLT/Blockchain platform). Having this knowledge will then enable a user to understand how to use this file in the "Setting up DLT network" section.
 
 ### How can I test whether my DLT/Blockchain network are configured and deployed correctly?
-Please see this [page](./operations/setting_dlt.md) for detials.
+Please see this [page](./operations/setting_dlt.md) for details.
 
 ### How/Where can I request for new features, bugs and get feedback?
 One could request a new feature on the Github repository for now. In the future, people might use Jira or Slack to do the same as well.
 
 ### Are CI/CD pipeline tools a mandatory to use Hyperledger Bevel?
-No, CI/CD pipeline tools like Jenkins are not mandatory, but it could help a user automate the set-up or testing of a new DLT/Blockchain network in different environments, once a user has a good understanding of using it. We have the main Jenkinsfile in `automation` folder which can be taken as a template.
+No, CI/CD pipeline tools like Jenkins are not mandatory, but it could help a user automate the set-up or testing of a new DLT/Blockchain network in different environments, once a user has a good understanding of using it. We have the main Jenkins file in `automation` folder which can be taken as a template.
 
 ### Is it required to run Ansible in a particular machine like AWS EC2?
 No, a user should be able to run the Ansible command on any machine as long as Ansible command CLI is installed.
@@ -89,7 +89,7 @@ No, a user should be able to run the Ansible command on any machine as long as A
 Yes, you can find an example ansible_hosts file [here](https://github.com/hyperledger/bevel/tree/main/platforms/shared/inventory/ansible_provisioners). The configuration in this file means that all Ansible commands will be run in the same machine that works as both an Ansible client and server machine.
 
 ### Can I specify the tools versions such as kubectl, helm in this project?
-Yes, you can specify tools versions like kubectl, helm, HashiCorp Vault, AWS-authenticator in the playbook [setup-environment.yaml](https://github.com/hyperledger/bevel/tree/main/platforms/shared/configuration/setup-environment.yaml).
+Yes, you can specify tools versions like kubectl, helm, HashiCorp Vault, AWS-Authenticator in the playbook [setup-environment.yaml](https://github.com/hyperledger/bevel/tree/main/platforms/shared/configuration/setup-environment.yaml).
 
 ### How would system react if we plan to update tools versions (e.g. kubectl, helm)?
 Honestly speaking, we don't know. The latest version Hyperledger Bevel has been tested on specific client versions of these tools, see below:
@@ -104,8 +104,8 @@ It is assumed that newer versions of these tools would be backward compatible, w
 ### Why does the Flux K8s pod get a permission denied for this Hyperledger Bevel GitHub repository?
 This usually means that the private key that you have used in your network.yaml for gitops does not have access to the GitHub repository. The corresponding public key must be added to your GitHub Account (or other git repository that you are using). Details can be found [here](https://github.com/hyperledger/bevel/tree/main/platforms/shared/configuration/).
 
-### Why does the flux-helm-operator keep on reporting "Failed to list *v1beta1.HelmRelease: the server could not find the requested resource (get helmreleases.flux.weave.works)"?
-The HelmRelease CustomResourceDefinition (CRD) was missing from the cluster, according to https://github.com/fluxcd/flux, the following command has to be used to deploy it:
+### Why does the flux-helm-operator keep on reporting "Failed to list *v1beta1.Helm Release: the server could not find the requested resource (get helm releases.flux.weave.works)"?
+The Helm Release CustomResourceDefinition (CRD) was missing from the cluster, according to https://github.com/fluxcd/flux, the following command has to be used to deploy it:
 ```
 kubectl apply -f https://raw.githubusercontent.com/fluxcd/flux/helm-0.10.1/deploy-helm/flux-helm-release-crd.yaml
 ```
diff --git a/docs/source/glossary.md b/docs/source/glossary.md
index 91f2f530f01..91e433b732b 100644
--- a/docs/source/glossary.md
+++ b/docs/source/glossary.md
@@ -78,10 +78,10 @@ For more details, refer: [Kubernetes](https://kubernetes.io/)
 A node is a worker machine in Kubernetes, previously known as a minion. A node may be a VM or physical machine, depending on the cluster. Each node contains the services necessary to run pods and is managed by the main components. The services on a node include the container runtime, kubelet and kube-proxy. 
 For more details, refer: [Kubernetes Node](https://kubernetes.io/docs/concepts/architecture/nodes/)
 ### Kubernetes Storage Class
-A StorageClass in Kubernetes provides a way for administrators to describe the “classes” of storage they offer. Different classes might map to quality-of-service levels, or to backup policies, or to arbitrary policies determined by the cluster administrators.
+A storageclass in Kubernetes provides a way for administrators to describe the “classes” of storage they offer. Different classes might map to quality-of-service levels, or to backup policies, or to arbitrary policies determined by the cluster administrators.
 For more details, refer: [Storage class](https://kubernetes.io/docs/concepts/storage/storage-classes/)
 ### Kubernetes PersistentVolume (PV)
-A PersistentVolume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes. It is a resource in the cluster just like a node is a cluster resource. PVs are volume plugins like Volumes, but have a lifecycle independent of any individual pod that uses the PV.
+A PersistentVolume (PV) is a piece of storage in the cluster that has been provisioned by an administrator or dynamically provisioned using Storage Classes. It is a resource in the cluster just like a node is a cluster resource. PV's are volume plugins like Volumes, but have a lifecycle independent of any individual pod that uses the PV.
 For more details, refer: [PVC](https://kubernetes.io/docs/concepts/storage/persistent-volumes/)
 ### Kubernetes Persistent Volume Claim (PVC)
 A PVC, binds a persistent volume to a pod that requested it. When a pod wants access to a persistent disk, it will request access to the claim which will specify the size , access mode and/or storage classes that it will need from a Persistent Volume.
@@ -154,7 +154,7 @@ For more details, refer: [MSP](https://hyperledger-fabric.readthedocs.io/en/rele
 Orderer peer is considered as the central communication channel for the Hyperledger Fabric network. Orderer peer/node is responsible for consistent Ledger state across the network. Orderer peer creates the block and delivers that to all the peers
 For more details, refer: [Orderer](https://hyperledger-fabric.readthedocs.io/en/release-1.4/orderer/ordering_service.html)
 ### Peer
-Hyperledger Fabric is a permissioned blockchain network that gets set by the organizations that intend to set up a consortium. The organizations that take part in building the Hyperledger Fabric network are called the “members”. Each member organization in the blockchain network is responsible to set up their peers for participating in the network. All of these peers need are configured with appropriate cryptographic materials like Certificate Authority and other information.
+Hyperledger Fabric is a permissioned blockchain network that gets set up by the organizations that intend to set up a consortium. The organizations that take part in building the Hyperledger Fabric network are called the "members." Each member organization in the blockchain network is responsible for setting up their peers to participate in the network. All of these peers need to be configured with appropriate cryptographic materials, like certificates of authority and other information.
 For more details, refer: [Peer](https://hyperledger-fabric.readthedocs.io/en/release-1.4/peers/peers.html)
 ### Zkkafka
 Kafka is primarily a distributed, horizontally-scalable, fault-tolerant, commit log. A commit log is basically a data structure that only appends. No modification or deletion is possible, which leads to no read/write locks, and the worst case complexity O(1). There can be multiple Kafka nodes in the blockchain network, with their corresponding Zookeeper ensemble.
@@ -178,9 +178,9 @@ For more details, refer: [CorDapp](https://docs.corda.net/cordapp-overview.html)
 A Corda node is a JVM run-time environment with a unique identity on the network that hosts Corda services and CorDapps.For more details, refer [Corda Node](https://docs.corda.net/key-concepts-node.html).
 
 ### Corda Web Server
-A simple web server is provided that embeds the Jetty servlet container. The Corda web server is not meant to be used for real, production-quality web apps. Instead it shows one example way of using Corda RPC in web apps to provide a REST API on top of the Corda native RPC mechanism.
+A simple web server is provided that embeds the Jetty servlet container. The Corda web server is not meant to be used for real, production-quality web apps. Instead, it shows one example of using Corda RPC in web apps to provide a REST API on top of the Corda native RPC mechanism.
 ### Doorman
-The Doorman CA is a Certificate Authority R3 Corda. It is used for day-to-day key signing to reduce the risk of the root network CA’s private key being compromised. This is equivalent to an intermediate certificate in the web PKI. For more details, refer [Doorman](https://docs.corda.net/releases/M16-RC04/permissioning.html).
+The Doorman CA is a Certificate Authority R3 Corda. It is used for day-to-day key signing to reduce the risk of the root network CA private key being compromised. This is equivalent to an intermediate certificate in the web PKI. For more details, refer [Doorman](https://docs.corda.net/releases/M16-RC04/permissioning.html).
 ### NetworkMap
 The Network Map Service accepts digitally signed documents describing network routing and identifying information from nodes, based on the participation certificates signed by the Identity Service, and makes this information available to all Corda Network nodes. For more details, refer [Networkmap](https://docs.corda.net/network-map.html).
 
@@ -217,7 +217,7 @@ An Identity Owner that has legal accountability (in a scenario where there is a
 A decentralized identifier as defined by the DID Data Model and Generic Syntax specification. DIDs enable interoperable decentralized self-sovereign identity management. An Identity Record is associated with exactly one DID. A DID is associated with exactly one DDO.
 
 ### Domain Genesis
-Domain genesis is a genesis file used to initialise the network and may populate network with some domain data.
+Domain genesis is a genesis file used to initialize the network and may populate network with some domain data.
 
 ### Endorser
 Endorser has the required rights to write on a ledger. Endorser submits a transaction on behalf of the original author.
@@ -229,13 +229,13 @@ The first Identity Record written to the Ledger that describes a new Ledger Enti
 A set of Identity Records, Claims, and Proofs that describes a Ledger Entity. To protect privacy: a) an Identity Owner may have more than one Ledger Identity, and b) only the Identity Owner and the Relying Party(s) with whom an Identity is shared knows the specific set of Identity Records, Claims, and Proofs that comprise that particular Identity.
 
 ### Identity Owner
-A Ledger Entity who can be held legally accountable. An Identity Owner must be either an Individual or an Organization. Identity owners can also be distinguised as Independent Identity Owner and Dependent Identity Owner based on the writer of the Genesis record, for an Independent Identity Owner the Genesis Record must be written by a Trust Anchor and in case of a Dependent Identity Owner the the Genesis Record must be written by a Guardian.
+A Ledger Entity who can be held legally accountable. An Identity Owner must be either an Individual or an Organization. Identity owners can also be distinguished as Independent Identity Owner and Dependent Identity Owner based on the writer of the Genesis record, for an Independent Identity Owner the Genesis Record must be written by a Trust Anchor and in case of a Dependent Identity Owner the the Genesis Record must be written by a Guardian.
 
 ### Identity Record
 A transaction on the Ledger that describes a Ledger Entity. Every Identity Record is associated with exactly one DID. The registration of a DID is itself an Identity Record. Identity Records may include Public Keys, Service Endpoints, Claim Definitions, Public Claims, and Proofs. Identity Records are Public Data.
 
 ### Identity Role
-Each identity has a specific role in Indy described by one of four roles in Indy. These roles are Trustee, Steward, Endorser and Netork Monitor.
+Each identity has a specific role in Indy described by one of four roles in Indy. These roles are Trustee, Steward, Endorser and Network Monitor.
 
 ### Issuer Key
 The special type of cryptographic key necessary for an Issuer to issue a Claim that supports Zero Knowledge Proofs.
@@ -250,7 +250,7 @@ NYM record is created for a specific user, Trust Anchor, Sovrin Stewards or trus
 A Pseudonym used in the context of only one digital relationship (Connection). See also Pseudonym and Verinym.
 
 ### Pool Genesis
-Pool genesis is a genesis file used to initialise the network and may populate network with some pool data.
+Pool genesis is a genesis file used to initialize the network and may populate network with some pool data.
 
 ### Private Claim
 A Claim that is sent by the Issuer to the Holder’s Agent to hold (and present to Relying Parties) as Private Data but which can be verified using Public Claims and Public Data. A Private Claim will typically use a Zero Knowledge Proof, however it may also use a Transparent Proof.
@@ -296,7 +296,7 @@ Haskell implementation of a general-purpose system for submitting information in
 Enode is a url which identifies a node, it is generated using the node keys.
 
 ### Istanbul Tool
-Istanbul tool is istanbul binary compiled from the code repository. The tool is used to generate the configuration files required for setting up the Quorum network with IBFT consensus.
+Istanbul tool is Istanbul binary compiled from the code repository. The tool is used to generate the configuration files required for setting up the Quorum network with IBFT consensus.
 
 ### Node Keys
 Node keys consist of node private and node public keys. Those keys are required by the binaries provided by Quorum to boot the node and the network.
@@ -308,19 +308,19 @@ Private Transactions are those Transactions whose payload is only visible to the
 Public Transactions are those Transactions whose payload is visible to all participants of the same Quorum network. These are created as standard Ethereum Transactions in the usual way.
 
 ### Quorum Node
-Quorum Node is designed to be a lightweight fork of geth in order that it can continue to take advantage of the R&D that is taking place within the ever growing Ethereum community. Quorum Node is running geth, a Go-Etherium client with rpc endpoints. It supports raft and IBFT pluggable consensus and private and permissioned transactions.  
+Quorum Node is designed to be a lightweight fork of geth in order that it can continue to take advantage of the R&D that is taking place within the ever growing Ethereum community. Quorum Node is running geth, a Go-Ethereum client with rpc endpoints. It supports raft and IBFT pluggable consensus and private and permissioned transactions.  
 
 ### State
 Quorum supports dual state, Public State(accessible by all nodes within the network) and Private State(only accessible by nodes with the correct permissions). The difference is made through the use of transactions with encrypted (private) and non-encrypted payloads (public). Nodes can determine if a transaction is private by looking at the v value of the signature. Public transactions have a v value of 27 or 28, private transactions have a value of 37 or 38.
 
 ### Static nodes
-Static nodes are nodes we keep reference to even if the node is not alive. So that when the nodes comes alive, then we can connect to it. Hostnames are permitted here, and are resolved once at startup. If a static peer goes offline and its IP address changes, then it is expected that that peer would re-establish the connection in a fully static network, or have discovery enabled.
+Static nodes are nodes we keep referring to even if the node is not alive. so that when the nodes come alive, we can connect to them. Hostnames are permitted here and are resolved once at startup. If a static peer goes offline and its IP address changes, then it is expected that that peer will re-establish the connection in a fully static network or have discovery enabled.
 
 ### Tessera
-Java implementation of a general-purpose system for submitting information in a secure way. it is  comparable to a network of MTA (Message Transfer Agents) where messages are encrypted with PGP. Contains Node ( Private transaction manager ) and The Enclave. 
+Java implementation of a general-purpose system for submitting information in a secure way. It is comparable to a network of MTA (Message Transfer Agents) where messages are encrypted with PGP. Contains Node (private transaction manager) and The Enclave.
 
 ### The Enclave
-Distributed Ledger protocols typically leverage cryptographic techniques for transaction authenticity, participant authentication, and historical data preservation (i.e. through a chain of cryptographically hashed data.) In order to achieve a separation of concerns, as well as to provide performance improvements through parallelization of certain crypto-operations, much of the cryptographic work including symmetric key generation and data encryption/decryption is delegated to the Enclave.
+Distributed ledger protocols typically leverage cryptographic techniques for transaction authenticity, participant authentication, and historical data preservation (i.e., through a chain of cryptographically hashed data). In order to achieve a separation of concerns as well as provide performance improvements through the parallelization of certain cryptographic operations, much of the cryptographic work, including symmetric key generation and data encryption and decryption, is delegated to the Enclave.
 
 ### Transaction Manager
-Quorum’s Transaction Manager is responsible for Transaction privacy. It stores and allows access to encrypted transaction data, exchanges encrypted payloads with other participant's Transaction Managers but does not have access to any sensitive private keys. It utilizes the Enclave for cryptographic functionality (although the Enclave can optionally be hosted by the Transaction Manager itself.)
+Quorum’s Transaction Manager is responsible for transaction privacy. It stores and allows access to encrypted transaction data, exchanges encrypted payloads with other participants' transaction managers, but does not have access to any sensitive private keys. It utilizes the Enclave for cryptographic functionality (although the Enclave can optionally be hosted by the Transaction Manager itself).
diff --git a/docs/source/introduction.md b/docs/source/introduction.md
index 29b3e2d7160..96a2650b6bb 100644
--- a/docs/source/introduction.md
+++ b/docs/source/introduction.md
@@ -7,7 +7,7 @@
 
 At its core, blockchain is a new type of data system that maintains and records data in a way that
 allows multiple stakeholders to confidently share access to the same data and information. A
-blockchain is a type of Distributed Ledger Technology (DLT), meaning it is a data ledger that is
+Blockchain is a type of Distributed Ledger Technology (DLT), meaning it is a data ledger that is
 shared by multiple entities operating on a distributed network.
 
 This technology operates by
@@ -19,12 +19,12 @@ and data, starting from the inception of that data structure.
 
 Setting up a new DLT/Blockchain network or maintaining an existing DLT/Blockchain network in a production-scale environment is not straightforward. For the existing DLT/Blockchain platforms, each has its own architecture, which means the same way of setting up one DLT/Blockchain network cannot be applied to others. 
 
-Therefore, when blockchain developers are asked to use an unfamiliar DLT/Blockchain platform, it requires significant effort for even experienced technicians to properly setup the DLT/Blockchain network. This is especially true in large-scale production projects across heterogeneous corporate environments which require other key aspects such as security and service availability.
+Therefore, when blockchain developers are asked to use an unfamiliar DLT/Blockchain platform, it requires significant effort for even experienced technicians to properly setup the DLT/Blockchain network. This is especially true in large-scale production projects across heterogeneous corporate environments, which require other key aspects such as security and service availability.
 
-Being aware of the potential difficulty and complexity of getting a production-scale DLT/Blockchain network ready, cloud vendors such as AWS and Azure have provisioned their own managed Blockchain services (aka Blockchain as a Service or BaaS) to help alleviate various pain-points during the process. However, limitations can still be identified in their BaaS solutions, e.g. limited network size, locked to all nodes on a single cloud provider, or limited choice of DLT/Blockchain platform, etc.
+Being aware of the potential difficulty and complexity of getting a production-scale DLT/Blockchain network ready, cloud vendors such as AWS and Azure have provisioned their own managed Blockchain services (aka Blockchain as a Service, or BaaS) to help alleviate various pain points during the process. However, limitations can still be identified in their BaaS solutions, e.g., limited network size, being locked to all nodes on a single cloud provider, a limited choice of DLT or blockchain platform, etc.
 
 ## **Hyperledger Bevel  Platform**
-The objective of Bevel is to provide a consistent means by which developers can deploy production-ready distributed networks across public and private cloud providers. This enables developers to focus on building business applications quickly, knowing that the framework upon which they are building can be adopted by an enterprise IT production operations organization. Bevel is not intended solely to quickly provision development environments which can be done more efficiently with other projects/scripts. Likewise, Hyperledger Bevel is not intended to replace BaaS offerings in the market, but instead, Bevel is an alternative when existing BaaS offerings do not support a consortium's current set of requirements. 
+The objective of Bevel is to provide a consistent means by which developers can deploy production-ready distributed networks across public and private cloud providers. This enables developers to focus on building business applications quickly, knowing that the framework upon which they are building can be adopted by an enterprise IT production operations organization. Bevel is not intended solely to quickly provision development environments, which can be done more efficiently with other projects or scripts. Likewise, Hyperledger Bevel is not intended to replace BaaS offerings in the market, but instead, Bevel is an alternative when existing BaaS offerings do not support a consortium's current set of requirements. 
 
 ![](../images/hyperledger-bevel-overview.png)
 
@@ -38,4 +38,4 @@ The objective of Bevel is to provide a consistent means by which developers can
 - Provides a sample supply chain application which runs on multiple DLT/Blockchain platforms that can be used as a reference pattern for how to safely abstract application logic from the underlying DLT/Blockchain platform
 
 ### What next?
- We have been actively searching for partners who need  and understand the value of Hyperledger Bevel, who share the vision of building and owning well architected solutions. We wish to work together so as to identify the market needs for those partners, to further reduce the barriers in adoption.
+ We have been actively searching for partners who need and understand the value of Hyperledger Bevel and who share the vision of building and owning well-architected solutions. We wish to work together so as to identify the market needs of those partners and further reduce the barriers to adoption.
diff --git a/docs/source/prerequisites.md b/docs/source/prerequisites.md
index 7dcc9468408..b131d4f47ce 100644
--- a/docs/source/prerequisites.md
+++ b/docs/source/prerequisites.md
@@ -5,7 +5,7 @@
 
 # Install Common Pre-requisites
 
-Following are the common pre-requiste software/client/platforms etc. needed before you can start deploying/operating blockchain networks using Hyperledger Bevel.
+Following are the common prerequisite software/client/platforms etc. needed before you can start deploying/operating blockchain networks using Hyperledger Bevel.
 
 ## Git Repository
 GitOps is a [key concept](keyconcepts) for Hyperledger Bevel, so a Git repository is needed for Bevel (this can be a [GitHub](https://github.com/) repository as well).
@@ -41,7 +41,7 @@ In this current release, [Hashicorp Vault](https://www.vaultproject.io/) is mand
 Follow [official instructions](https://developer.hashicorp.com/vault/docs/install) to deploy Vault in your environment. 
 
 ---
-**NOTE:** Recommended approach is to create one Vault deployment on one VM and configure the backend as a cloud storage.
+**NOTE:** The recommended approach is to create one Vault deployment on one VM and configure the backend as cloud storage.
 
 Vault version should be **1.13.1**
 
@@ -58,7 +58,7 @@ Although for production implementations, each organization (and thereby each clu
 
 ## Docker
 
-Hyperledger Bevel provides pre-built docker images which are available on [GitHub Repo](https://github.com/orgs/hyperledger/packages?repo_name=bevel). If specific changes are needed in the Docker images, then you can build them locally using the Dockerfiles provided. A user needs to install [Docker CLI](https://docs.docker.com/install/) to make sure the environment has the capability of building these Dockerfiles to generate various docker images. Platform specific docker image details are mentioned [here](./operations/configure_prerequisites.md).
+Hyperledger Bevel provides pre-built docker images which are available on [GitHub Repo](https://github.com/orgs/hyperledger/packages?repo_name=bevel). If specific changes are needed in the Docker images, then you can build them locally using the Docker files provided. A user needs to install [Docker CLI](https://docs.docker.com/install/) to make sure the environment has the capability of building these Docker files to generate various docker images. Platform specific docker image details are mentioned [here](./operations/configure_prerequisites.md).
 
 ---
 **NOTE:** Hyperledger Bevel uses minimum Docker version **18.03.0**
diff --git a/docs/source/prerequisites_machine.md b/docs/source/prerequisites_machine.md
index 8da308bf714..35bbab2fdd4 100644
--- a/docs/source/prerequisites_machine.md
+++ b/docs/source/prerequisites_machine.md
@@ -19,7 +19,7 @@ Please note that this machine (also called **Ansible Controller**) should have c
 
 ---
 
-Also, Ansible's k8s module requires the **openshift python package (>= 0.12.0)** and some collections and jq.
+Also, Ansible k8s module requires the **openshift python package (>= 0.12.0)** and some collections and jq.
 
 ```bash
 pip3 install openshift==0.13.1
@@ -43,4 +43,4 @@ Read more about Ansible inventory [here](https://docs.ansible.com/ansible/latest
 
 Hyperledger Bevel provides the feature of automated validation of the configuration file (network.yaml), this is done using ajv (JSON schema validator) cli. The deployment scripts install ajv using npm module which requires npm as prerequisite.
 
-You can install the latest NPM version from offical [site](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
+You can install the latest NPM version from official [site](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).