Eric Berg - technical writing portfolio

On-call incident response how-to

Mon, 01 Jan 0001 00:00:00 +0000

On-call incident response how-to#

This document’s audience is junior Site Reliability Engineers getting accustomed to on-call responsibilities. As a sample of my work, it’s an important document because it reduces procedural errors when going on-call, making incidents smoother to resolve.

This how-to guide walks you through what you should do if you’re paged for an incident. It’s written to keep you aware of best practices and to make responding to an incident routine.

Introducing rpmbuild

Mon, 01 Jan 0001 00:00:00 +0000

Introducing rpmbuild#

This document’s audience is engineers evaluating rpmbuild as part of their build tooling. As a sample of my work, it’s an important document because it offers an introduction to an open-source project, allowing the project a wider use.

Key concepts#

Docker: Linux containers you can run on your existing infrastructure
Pants: A build system that manages dependencies across large codebases
RPM: Red Hat Package Manager. A way to package software for distribution on a machine
RPM spec file: A configuration file for building a specific RPM

What rpmbuild is#

When creating RPMs, it’s important to have a consistent build environment and reproducible builds. It also can be useful to be able to build RPMs in a virtual environment, so you don’t need a dedicated build machine.

Introducing alertmon

Mon, 01 Jan 0001 00:00:00 +0000

Introducing alertmon#

This document’s audience is engineers or engineering managers evaluating alertmon as a part of their infrastructure. As a sample of my work, it’s an important document because it offers an introduction to an open-source project, allowing the project a wider use.

What alertmon is#

In production systems, you need a bridge between time-series databases, which generate an enormous amount of metrics, and a paging system. Alertmon acts as that bridge.

Creating an alert with alertmon

Mon, 01 Jan 0001 00:00:00 +0000

Creating an alert with alertmon#

This document’s audience is engineers looking to create an alert on an already configured instance of alertmon. As a sample of my work, it’s an important document because it shows how I would write a tutorial, saving valuable user time and reducing support work.

In this tutorial you will create an alert with alertmon. Along the way you will dive into the different pieces of configuration that go into creating an alert.

Alertmon reference

Mon, 01 Jan 0001 00:00:00 +0000

Alertmon reference#

This document’s audience is engineers looking to understand the scope of alertmon, reference how to use a specific url, or look up how to use a specific feature. As a sample of my work, it’s an important document because it shows how I would write a reference guide, saving valuable user time and reducing support work.

This reference guide explains each of the endpoints associated with alertmon. It walks through the url, the methods, associated parameters, and a description of the endpoint.