diff --git a/docs/developer/ci-workflow.md b/docs/developer/ci-workflow.md
index 51cbf513798cc06d452f6f7b767bc97bd711aac8..431392be40ea65d4cccfac60b816db60ae08ed28 100644
--- a/docs/developer/ci-workflow.md
+++ b/docs/developer/ci-workflow.md
@@ -1,6 +1,6 @@
-# BigBang GitLab CI Workflow
+# Big Bang GitLab Continuous Integration (CI) Workflow
-The following is meant to serve as an overview of the pipeline stages required to get a commit merged. There are package, bigbang, and infrastructure pipelines.
+This document is meant to serve as an overview of the pipeline stages required to get a commit merged. There are package, bigbang, and infrastructure pipelines.
[[_TOC_]]
@@ -10,7 +10,7 @@ The following is meant to serve as an overview of the pipeline stages required t
These run on a privileged node pool with limited access to allow for docker in docker k3d clusters.
* Package runners:
- * Separate runners for each BBTOC stage; graduated, incubating, and sandbox.
+ * Separate runners for each BBTOC stage: graduated, incubating, and sandbox.
* These run package k3d pipelines.
* bigbang runner:
* Runner used specifically for the bigbang repo.
@@ -37,7 +37,7 @@ This pipeline is triggered by the following for individual bigbang packages:
-[Link to draw.io diagram file](../assets/diagrams/developer/bb-gitlab-ci-diagram.drawio). This diagram file should be modified on draw.io and exported into this repository when the developer/ci workflow changes. It is provided here for ease of use.
+[Link to draw.io diagram file](../assets/diagrams/developer/bb-gitlab-ci-diagram.drawio). This diagram file should be modified on draw.io and exported into this repository when the developer/CI workflow changes. It is provided here for ease of use.
### Chart Update Check
@@ -58,7 +58,7 @@ This stage checks the MR description to ensure the `## Upgrade Notices` section
### Package Tests
-This stage verifies several easy-to-check assumptions, including:
+This stage verifies several easy-to-check assumptions, including the following:
* Does package successfully install?
* Does package successfully upgrade (from master)?
@@ -191,10 +191,10 @@ Currently, there are three test scripts that test the following:
### Teardown
-Infrastructure teardown happens in the reverse sequence as to which they are deployed, and the pipeline will ensure these teardown jobs are _always_ ran, regardless of whether or not the previous jobs were successful.
+Infrastructure teardown happens in the reverse sequence as to which they are deployed, and the pipeline will ensure these teardown jobs are *always* ran, regardless of whether or not the previous jobs were successful.
Combined with terraform's declarative remote state, the "always on" teardown ensures no orphaned resources are left over once tests are run.
Within the teardown process, the commit scoped terraform workspace is also deleted to ensure the remote state remains clean.
-For example, if an RKE2 cluster fails to provision, a full teardown of BigBang, RKE2, and the network will be run, even though BigBang was never deployed. This will result in 2 failing jobs (RKE2 up and BigBang down), but will ensure that no infrastructure resources become orphaned.
+For example, if an RKE2 cluster fails to provision, a full teardown of bigbang, RKE2, and the network will be run, even though BigBang was never deployed. This will result in two failing jobs (i.e., RKE2 up and bigbang down), but will ensure that no infrastructure resources become orphaned.
diff --git a/docs/developer/k8s-storage.md b/docs/developer/k8s-storage.md
index 699f1742df10fcbc1206e04fab33dfee26a3930b..e667e93704c82abfe826e049087af471720f8099 100644
--- a/docs/developer/k8s-storage.md
+++ b/docs/developer/k8s-storage.md
@@ -1,6 +1,6 @@
# Kubernetes Storage Options
-Use this data to assist in your CSI decision. However, when using a cloud provider we suggest you use their Kubernetes CSI.
+Use this data to assist in your CSI decision. However, when using a cloud provider, we suggest you use their Kubernetes CSI.
## Feature Matrix
@@ -32,12 +32,12 @@ Benchmarks were tested on AWS with GP2 ebs volumes using using FIO, see [example
### Requirements
-- Must be using AWS
+- Must be using AWS.
### Notes
- Apache License 2.0
-- Very easy to install and use, apply CSI spec and you are ready.
+- Very easy to install and use; apply CSI spec and you are ready.
## Azure Disk CSI
@@ -45,12 +45,12 @@ Benchmarks were tested on AWS with GP2 ebs volumes using using FIO, see [example
### Requirements
-- Must be using Azure
+- Must be using Azure.
### Notes
- Apache License 2.0
-- Very easy to install and use, apply CSI spec and you are ready.
+- Very easy to install and use; apply CSI spec and you are ready.
## Longhorn
@@ -63,20 +63,20 @@ Benchmarks were tested on AWS with GP2 ebs volumes using using FIO, see [example
### Notes
- Apache License 2.0
-- Easiest to install
+- Easiest to install.
- Built-in backup tool.
-- Documented airgap install process. [Docs](https://longhorn.io/docs/1.1.0/advanced-resources/deploy/airgap/)
+- Documented airgap install process: [Docs](https://longhorn.io/docs/1.1.0/advanced-resources/deploy/airgap/).
- GUI provides data and observability; replica status, cluster health status, backup status, and backup initiation/recovery.
-- Native backup to S3 or NFS
+- Native backup to S3 or NFS.
## OpenEBS
-[Website/Docs](https://openebs.io/)
+- [Website/Docs](https://openebs.io/)
### Requirements
-- Blank and un-partitioned attached disk(s)
-- RWX is in Alpha and requires work. [OpenEBS RWX Docs](https://docs.openebs.io/docs/next/rwm.html)
+- Blank and un-partitioned attached disk(s).
+- RWX is in Alpha and requires work; [OpenEBS RWX Docs](https://docs.openebs.io/docs/next/rwm.html).
### Notes
@@ -101,8 +101,8 @@ Benchmarks were tested on AWS with GP2 ebs volumes using using FIO, see [example
### Notes
-- Rook - Apache License 2.0.
-- Ceph - dual licensed under the LGPL version 2.1 or 3.0
+- Rook: Apache License 2.0.
+- Ceph: dual licensed under the LGPL version 2.1 or 3.0.
- Very Fast
## Portworx