Skip to content

Commit 6ac8242

Browse files
committed
docs: made iteration to PR
1 parent 7f0eca4 commit 6ac8242

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

docs/configuration/runme-gist.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Runme Gist combines GitHub Gist with Runme capabilities to run, share, and store
1919
As stated earlier, Runme Gist combines GitHub Gist with Runme capabilities to enable you to securely run, share, and store code snippets. In this section, we will explain how Runme Gist works using a step-by-step guide.
2020

2121
1. Open your Markdown File
22-
Create a `Readme.md` file and open it in your VS Code. If you already have the file you want to use, open it in VS Code.
22+
Create a `README.md` file and open it in your VS Code. If you already have the file you want to use, open it in VS Code.
2323
2. Run Cells
2424
Run your notebook cells, and ensure the [auto-save feature](../configuration/auto-save) is turned on to save your outputs without manual intervention.
2525

@@ -32,12 +32,12 @@ To view your session output, click “Sessions Outputs” to inspect the locally
3232

3333
![Runme gist session output](../../static/img/configuration-page/runme-gist-sessionoutput.png)
3434

35-
The Session Outputs feature is only available when the autosave is activated and the Runme cell is run.
35+
The Session Outputs feature is only available when the autosave is enabled and the Runme cell is run.
3636

3737
4. Toggle Between Mask and Unmask
3838
You can decide if you want your session outputs to be masked or unmasked.
3939
The masked and unmasked options are how Runme keeps your sensitive information secret. If you want to keep your sensitive information secret, you should toggle the mask option otherwise, choose the unmasked option.
40-
By default, Runme uses the open-source data guardian to mask sensitive information on a best-effort basis.
40+
Otherwise, Runme uses the open-source `data-guardian` library to mask sensitive information on a best-effort basis.
4141

4242

4343
![Runme gist unmask](../../static/img/configuration-page/runme-gist-unmask.png)

docs/guide/monitoring-stack.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A monitoring stack is a set of tools that collect, process, and visualize data f
44

55
Most often, instructions which define setting up and configuration of monitoring stack procedures are set in multiple documents which can be overwhelming. This is where Runme comes in! Runme provides a platform that helps you document all the standardized processes needed to set up and configure your monitoring stack, centralizing your procedures and processes in an interactive runbook accessible to you and your team.
66

7-
With Runme, you create a set of predefined procedures and instructions for installing and configuring all dependencies needed for your monitoring stack, such as [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/), etc.
7+
With Runme, you create a set of predefined procedures and instructions for installing and configuring all dependencies needed for your monitoring stack, such as [Prometheus](https://prometheus.io/), [Grafana](https://grafana.com/) and others.
88

99
In this guide, we will walk you through configuring a monitoring stack and creating a Runbook for your application setup and configuration using Runme.
1010

@@ -30,7 +30,7 @@ Runme uses its [environment variable prompt feature](https://docs.runme.dev/gett
3030

3131
## Configure Your Node Exporter In Your Runbook
3232

33-
To configure your node exporter, you must follow three steps.
33+
To configure your Node Exporter, you must follow three steps.
3434

3535
Step One: Set Up Node Exporter as a Service
3636

@@ -164,31 +164,31 @@ You installed Grafana on your local machine using Runme in the previous step. No
164164
open http://localhost:3000
165165
```
166166

167-
## Install Alert Manager
167+
## Install Alertmanager
168168

169-
An alert manager is a component of a monitoring stack that handles alerts sent by monitoring tools like Prometheus. It is responsible for grouping, deduplication, and routing alerts to the appropriate recipients. To install an alert manager and make it a part of your monitoring stack, navigate to the “[Install Alert Manager](https://github.com/stateful/blog-examples/blob/main/kubernetes/monitoring-stack/linux.md#install-alert-manager)” section in the cloned repository, enter the command in your Runme cell, and run it.
169+
An Alertmanager is a component of a monitoring stack that handles alerts sent by monitoring tools like Prometheus. It is responsible for grouping, deduplication, and routing alerts to the appropriate recipients. To install an Alertmanager and make it a part of your monitoring stack, navigate to the “[Install Alertmanager](https://github.com/stateful/blog-examples/blob/main/kubernetes/monitoring-stack/linux.md#install-alert-manager)” section in the cloned repository, enter the command in your Runme cell, and run it.
170170

171171
![Install Alertmanager](../../static/img/guide-page/alertmanager-runme.png)
172172

173173
You can edit your `alertmanager.yml` file to define the alerting configurations, notification integrations, and routing rules. To do that, run this command in your Runme cell `nano /etc/alertmanager/alertmanager.yml`
174174

175-
## Configure and Run Your Alert Manager
175+
## Configure and Run Your Alertmanager
176176

177-
You will follow three steps to configure and run your alert manager.
177+
You will follow three steps to configure and run your Alertmanager.
178178

179-
Step One: Set Up Alert Manager as a Service
180-
Create a `systemd` service file for Alertmanager, specify its description, user-startup command, and target for activation. To do this, navigate to the “[Setup Alert Manager as a Service](https://github.com/stateful/blog-examples/blob/main/kubernetes/monitoring-stack/linux.md#setup-alert-manager-as-a-service)” section, enter the command, and run it in your Runme cell.
179+
Step One: Set Up Alertmanager as a Service
180+
Create a `systemd` service file for Alertmanager, specify its description, user-startup command, and target for activation. To do this, navigate to the “[Setup Alertmanager as a Service](https://github.com/stateful/blog-examples/blob/main/kubernetes/monitoring-stack/linux.md#setup-alert-manager-as-a-service)” section, enter the command, and run it in your Runme cell.
181181

182182
![alertmanager](../../static/img/guide-page/Alertmanager.service.png)
183183

184-
Step Two: Run Alert Manager as a Service
185-
Now, you can run your alert manager as a service. To do this, navigate to the “[Run Alert as a Service](https://github.com/stateful/blog-examples/blob/main/kubernetes/monitoring-stack/linux.md#run-alert-manager-as-a-service)” section, enter the command in your Runme cell, and run it.
184+
Step Two: Run Alertmanager as a Service
185+
Now, you can run your Alertmanager as a service. To do this, navigate to the “[Run Alert as a Service](https://github.com/stateful/blog-examples/blob/main/kubernetes/monitoring-stack/linux.md#run-alert-manager-as-a-service)” section, enter the command in your Runme cell, and run it.
186186

187187
![alertmanager-service](../../static/img/guide-page/runme-alertmanager.png)
188188

189189
Step Three: Open the app
190190

191-
To open the alert manager page on your local machine, run the command below in your Runme cell.
191+
To open the Alertmanager page on your local machine, run the command below in your Runme cell.
192192

193193
```sh
194194
open http://localhost:9093

0 commit comments

Comments
 (0)