docs: iteration to guide

edeediong · edeediong · commit bf1e15c62b29 · 2024-04-18T15:51:17.000+01:00
diff --git a/docs/guide/k8s-secret.md b/docs/guide/k8s-secret.md
@@ -2,24 +2,24 @@
 
 Runme provides a platform for documenting processes and instructions. It integrates swiftly with cloud infrastructures, including Kubernetes and its resources.
 
-This guide will explore one such resource, Kubernetes secrets, with a specific focus on sealed secrets.
+This guide will explore one such resource, Kubernetes secrets, with a specific focus on Sealed Secrets.
 
 [Sealed Secrets](https://archive.eksworkshop.com/beginner/200_secrets/installing-sealed-secrets/) is an open-source project that helps encrypt Kubernetes secrets, which can then be securely stored in your version control. Runme makes securing these secrets easier.
 
-In this guide, we will demonstrate the steps required to encrypt Kubernetes secrets with sealed secrets in Runme successfully.
+In this guide, we will demonstrate the steps required to encrypt Kubernetes secrets with Sealed Secrets in Runme successfully.
 
 ## **Prerequisites**[](https://docs-runme-55rq3q1vz-stateful.vercel.app/guide/k8s-secret#prerequisites)
 
 To get started, ensure you have the following:
 
-- **Clone the repo**: We created a [notebook repo](https://github.com/stateful/blog-examples/tree/main/kubernetes/k8s-secret/sealed-secret) containing all the instructions and commands required for this guide.
-- **Install Runme**: Install the [Runme extension on VS Code](https://marketplace.visualstudio.com/items?itemName=stateful.runme) and set it as your [default markdown Viewer.](https://docs.runme.dev/installation/installrunme#how-to-set-vs-code-as-your-default-markdown-viewer)
+- **Clone the repository**: We created a [notebook repository](https://github.com/stateful/blog-examples/tree/main/kubernetes/k8s-secret/sealed-secret) containing all the instructions and commands required for this guide.
+- **Install Runme**: Install the [Runme extension on VS Code](https://marketplace.visualstudio.com/items?itemName=stateful.runme) and set it as your [default Markdown viewer.](https://docs.runme.dev/installation/installrunme#how-to-set-vs-code-as-your-default-markdown-viewer)
 
 This guide will focus on using the Mac specifications. If you use a Linux OS, follow the instructions in the [Linux Markdown files.](https://github.com/stateful/blog-examples/blob/main/kubernetes/k8s-secret/sealed-secret/linux-sealedsecrets.md)
 
 ### Install all Dependencies
 
-To follow up on securing your secrets using sealed secrets, ensure you install the necessary dependencies in the notebook's prerequisite section. In your Runme cell, run the commands below to install all dependencies required for this guide.
+To follow up on securing your secrets using Sealed Secrets, ensure you install the necessary dependencies in the notebook's prerequisite section. In your Runme cell, run the commands below to install all dependencies required for this guide.
 
 <video autoPlay loop muted playsInline controls>
   <source src="/videos/sealed-secrets-runme.mp4" type="video/mp4" />
@@ -30,7 +30,7 @@ To follow up on securing your secrets using sealed secrets, ensure you install t
 
 To encrypt a secret, you must create a Kubernetes secret using `kubeseal`. Navigate to your cloned repo's ‘Encrypt a Secret’ section and [choose your preferred encryption method from the options provided.](https://github.com/stateful/blog-examples/blob/main/kubernetes/k8s-secret/sealed-secret/Mac-sealedsecret.md#encrypt-a-secret)  Once that is done, run the command below in your Runme cell.
 
-Runme will automatically create a sealed secret resource containing the encrypted data, the **`mysealedsecret.yaml`**
+Runme will automatically create a Sealed Secret resource containing the encrypted data, the **`mysealedsecret.yaml`**
 
 ### Adding New Value to A Secret
 
@@ -60,9 +60,9 @@ To deploy your secret, execute the code below:
 
 ![deploy sealed](../../static/img/guide-page/sealed-apply.png)
 
-The Sealed Secrets controller will decrypt the SealedSecret and create a Kubernetes Secret with the decrypted data.
+The Sealed Secrets controller will decrypt the Sealed Secret and create a Kubernetes Secret with the decrypted data.
 
-Make sure to replace placeholders like **`mysecret.yaml`** and **`mysealedsecret.yaml`** with your secret and sealed secret filenames. Adjust controller-specific details such as the namespace and name according to your environment.
+Make sure to replace placeholders like **`mysecret.yaml`** and **`mysealedsecret.yaml`** with your secret and Sealed Secret filenames. Adjust controller-specific details such as the namespace and name according to your environment.
 
 ## How Runme Improves Your Documentation Experience
 
diff --git a/docs/guide/replicaset.md b/docs/guide/replicaset.md
@@ -1,25 +1,25 @@
 # How to Optimize Kubernetes Replicaset Using Runme
 
 Runme provides a platform that allows you to create standardized procedures for configuring, deploying, and managing your everyday operational tools and resources.
-Working with essential kubernetes controller like [ReplicaSets](https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/) ensures that you have high availability of your pod and improve the scalability of your applications . With Runme, you can optimize these process right within your Markdown file!
+Working with essential Kubernetes controller like [ReplicaSets](https://kubernetes.io/docs/concepts/workloads/controllers/replicaset/) ensures that you have high availability of your pod and improve the scalability of your applications. With Runme, you can optimize these process right within your Markdown file!
 
-This guide will show you a step-by-step guide to configure and deploy your Kubernetes ReplicaSets within your Runme Notebook.
+This guide will show you a step-by-step process to configure and deploy your Kubernetes ReplicaSets within your Runme Notebook.
 
 ## Prerequisites
 
 To follow up on this tutorial, ensure you have the following:
 
 - **Runme Extension**: Install the [Runme extension](https://marketplace.visualstudio.com/items?itemName=stateful.runme) in your VS Code editor and make it your [default Markdown viewer](https://docs.runme.dev/installation/installrunme#how-to-set-vs-code-as-your-default-markdown-viewer). Runme also provides other client interfaces where you can run your Markdown file. See the [Runme installation](../installation/index.md) guide.
-- **Clone Repo**: We have provided an example repo to help you follow this tutorial. Clone the [repo here](https://github.com/stateful/blog-examples/tree/main/kubernetes/replicaset).
-- **Require Packages**: Install the required packages (brew, kind, and kubectl) inside your Markdown file. *Runme allows you to achieve this! Simply run the command in the [prerequisite section](https://github.com/stateful/blog-examples/blob/main/kubernetes/replicaset/replicaset-mac.md#prerequisites) in the repo*.
+- **Clone Repository**: We have provided an example repository to help you follow this tutorial. Clone the [Repository here](https://github.com/stateful/blog-examples/tree/main/kubernetes/replicaset).
+- **Require Packages**: Install the required packages (brew, kind, and kubectl) inside your Markdown file. *Runme allows you to achieve this! Simply run the command in the [prerequisite section](https://github.com/stateful/blog-examples/blob/main/kubernetes/replicaset/replicaset-mac.md#prerequisites) in the repository*.
 
 To get started, we have already [created a ReplicaSet](https://github.com/stateful/blog-examples/blob/main/kubernetes/replicaset/manifest.yaml) using a YAML configuration file. Here, we will demonstrate how you can manage the deployment of the Replicaset with Kubernetes. Before we deploy the ReplicaSet to Kubernetes, let us apply the functionalities to this file within your Runme cell.
 
 ## Configure your ReplicaSet for deployment in Runme
 
 **Apply ReplicaSet Configurations in Runme**
 
-In your cell, run the command below. This command instructs Kubernetes to create and update the resources specified in the YAML file. :
+In your cell, run the command below. This command instructs Kubernetes to create and update the resources specified in the YAML file:
 
 ![apply-manifest](../../static/img/guide-page/runme-apply-manifest.png)
 
@@ -41,7 +41,7 @@ If you want to modify the desired number of replicas for the specified ReplicaSe
 
 ![number-replica](../../static/img/guide-page/runme-get-scale.png)
 
-The `--replicas=` command helps you set the number of replica pods you want 
+The `--replicas=` command helps you set the number of replica pods you want
 
 When the command is executed, Runme displays a confirmation message indicating that the ReplicaSet has been scaled.
 
@@ -51,7 +51,7 @@ To follow the logs of a specific pod in real time, run the command below
 
 ![replica-log](../../static/img/guide-page/runme-replica-logs.png)
 
-When this command is executed, Runme returns logs about the specific Pod. This information can be used to debug or troubleshoot a pod. As provided in the image above
+When this command is executed, Runme returns logs about the specific pod. This information can be used to debug or troubleshoot a pod. As provided in the image above
 
 ## How to Manage ReplicaSets Using a Deployment in Runme
 
@@ -61,7 +61,7 @@ This section will walk you through the step-by-step process of managing ReplicaS
 
 **Step One: Deploy your application with Runme**
 
-You need to create a manifest file to deploy your application to your Kubernetes cluster. For the tutorial, we will be deploying an  [NGINX web server application](https://github.com/stateful/blog-examples/blob/main/kubernetes/replicaset/nginx-deployment.yaml). This Kubernetes manifest deploys our NGINX application into the "runme" namespace and specifies that it should manage a set of 5 identical Pods running the NGINX web server.
+You need to create a manifest file to deploy your application to your Kubernetes cluster. For the tutorial, we will be deploying an [NGINX web server application](https://github.com/stateful/blog-examples/blob/main/kubernetes/replicaset/nginx-deployment.yaml). This Kubernetes manifest deploys our NGINX application into the "runme" namespace and specifies that it should manage a set of 5 identical Pods running the NGINX web server.
 
 **Step Two: Update the Manifest File**
 
@@ -77,7 +77,7 @@ This will update your deployment with the defined ReplicaSet.
 
 ReplicaSet ensures that the specified number of identical pods are running at all times, so if a pod gets deleted, the ReplicaSet automatically creates a replacement pod to maintain the desired replica count. To delete a pod, run the command below in your Runme cell, and you will see an output that is identical to the one generated in the image.
 
-![delet pod](../../static/img/guide-page/runme-delete-pod.png)
+![delete pod](../../static/img/guide-page/runme-delete-pod.png)
 
 **Step Four: View Kubernetes Events in your Runme terminal**
 
diff --git a/docs/guide/sops.md b/docs/guide/sops.md
@@ -12,17 +12,17 @@ In this guide, we will walk you through automating your [Kubernetes Secrets](htt
 
 To get started, ensure you have the following:
 
-- **Clone the Repo**: We have created a notebook repo containing all the instructions and commands required for this guide. Ensure to [clone the repo](https://github.com/stateful/blog-examples/tree/main/kubernetes/k8s-secret).
+- **Clone the Repository**: We have created a notebook repository containing all the instructions and commands required for this guide. Ensure to [clone the repository](https://github.com/stateful/blog-examples/tree/main/kubernetes/k8s-secret).
 - **Install Runme:** Install the [Runme extension on VS Code](https://marketplace.visualstudio.com/items?itemName=stateful.runme) and set Runme as your [default Markdown viewer.](https://docs.runme.dev/installation/installrunme#how-to-set-vs-code-as-your-default-markdown-viewer)
-- **Require Packages**: Install the required packages (brew, kind, and kubectl) inside your Markdown file. *Runme allows you to achieve this! Simply run the command in the [prerequisite section](https://github.com/stateful/blog-examples/blob/main/kubernetes/replicaset/replicaset-mac.md#prerequisites) of the repo.*
+- **Require Packages**: Install the required packages (brew, kind, and kubectl) inside your Markdown file. *Runme allows you to achieve this! Simply run the command in the [prerequisite section](https://github.com/stateful/blog-examples/blob/main/kubernetes/replicaset/replicaset-mac.md#prerequisites) of the repository.*
 
 This guide will focus on using the Mac specifications. If you use a Linux OS, follow the instructions in the [Linux Markdown files](https://github.com/stateful/blog-examples/blob/main/kubernetes/k8s-secret/sops/sops-linux.md).
 
 ## **Securing Secrets with SOPS**[](https://docs-runme-55rq3q1vz-stateful.vercel.app/guide/k8s-secret#securing-secrets-with-sops)
 
 To encrypt your Kubernetes secrets using SOPS, you need an advanced security measure, access to a cloud provider, and a Key Management Service (KMS). For this guide, we will use an [AWS KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys).
 
-Navigate to the [SOPS file](https://github.com/stateful/blog-examples/tree/main/kubernetes/k8s-secret/sops) in the repo you cloned earlier and open the Markdown file based on the specifications of your operating system to follow up on this section of the guide.
+Navigate to the [SOPS file](https://github.com/stateful/blog-examples/tree/main/kubernetes/k8s-secret/sops) in the repository you cloned earlier and open the Markdown file based on the specifications of your operating system to follow up on this section of the guide.
 
 ### **Installation of SOPS**[](https://docs-runme-55rq3q1vz-stateful.vercel.app/guide/k8s-secret#installation-of-sops)
 
@@ -47,18 +47,18 @@ You can also save this output to the Runme cloud for future use with the [Runme
 
 ### **Configure SOPS in Runme** [](https://docs-runme-55rq3q1vz-stateful.vercel.app/guide/k8s-secret#configure-sops)
 
-To configure your SOPS, specify how to encrypt your secrets, then define the encryption keys. To do this, navigate to the section on SOPS configuration and run the command in your Markdown file using Runme.
+To configure your SOPS, specify how to encrypt your secrets, and then define the encryption keys. To do this, navigate to the section on SOPS configuration and run the command in your Markdown file using Runme.
 
 ![sops](../../static/img/guide-page/configure-sops.png)
 
 Once this is executed, it returns the configuration of your sops.yaml file to ensure that it is correct.
 
 ### **Encrypt Your Secrets**[](https://docs-runme-55rq3q1vz-stateful.vercel.app/guide/k8s-secret#encrypt-your-secrets)
 
-To encrypt your secret, ensure you have set the following:
+To encrypt your secret, ensure you have the following information set:
 
 - Your environment variables
-- Your manifest `runme-secrets.yaml` file containing your secrets. If you have not done this, create one using the following YAML manifest in [our repo](https://github.com/stateful/blog-examples/blob/main/kubernetes/k8s-secret/sops/runme-secrets.yaml).
+- Your manifest `runme-secrets.yaml` file containing your secrets. If you have not done this, create one using the following YAML manifest in [our repository ](https://github.com/stateful/blog-examples/blob/main/kubernetes/k8s-secret/sops/runme-secrets.yaml).
 - Click the **execute cell** button.
 
 ![encrypt](../../static/img/guide-page/runme-encrypt.png)
@@ -69,7 +69,7 @@ Now, we have successfully encrypted your secrets within `runme-secrets.yaml`. Ru
 
 Similar to the encryption process, Runme lets you decrypt your encrypted security in your Markdown file. This will ensure that every process is properly automated.
 
-To decrypt your secrets, navigate to the “Decrypt Secrets” section in the repo and run the command in your Markdown file with Runme.
+To decrypt your secrets, navigate to the “Decrypt Secrets” section in the repository and run the command in your Markdown file with Runme.
 
 ![decrypt](../../static/img/guide-page/runme-decrypt.png)
 
@@ -87,8 +87,8 @@ This runs the `runme-secrets-enc.yaml` file decrypts it and then applies the fil
 
 We successfully encrypted our Kubernetes secrets inside our Markdown file. Runme makes your automation process easy with its features.
 
-One of these features is the [environment variable](https://docs-runme-ckcd767be-stateful.vercel.app/getting-started/features#environment-variable-prompts) feature, which allows users to input values directly within the notebook environment and use them whenever needed rather than inputting the value again.
+One of the useful features within the notebook environment is the [environment variable prompt](https://docs-runme-ckcd767be-stateful.vercel.app/getting-started/features#environment-variable-prompts). It allows users to input values directly and reuse them whenever needed.
 
-Another amazing key feature of Runme is the [Autosave](https://docs.runme.dev/configuration/auto-save) feature, which automatically records and tracks every change and activity in your processes without manual intervention.
+Runme's [Autosave](https://docs.runme.dev/configuration/auto-save) feature automatically tracks all changes and activities without manual intervention.
 
 To learn more about Runme and explore its features, visit the [Runme Documentation](https://docs.runme.dev/) to begin your journey to automating your operations processes.
