How Does This Site Work?

Hey everyone, I’m Jacob!

Introduction

For a long time I have wanted to write a blog, and I finally got around to setting it up.

I worked in IT for 5 years before becoming a software developer and I always got frustrated with blogs. I would Google an issue and find an article from someone who seemed to have a solution, and then they would leave out literally every critical detail. Another frustration was when I would try and find tutorials on how to set up something (usually a piece of enterprise software), and then there would only be a super old article when the product was first released. This blog exists to solve both of those issues!

My goal is to write about two main things:

1. Weird issues I couldn’t find a good solution to on the internet, but eventually solved myself
2. Tutorials for products where there aren’t any good tutorials, the tutorials are outdated, or the tutorials were not written to support production workloads or real-world scenarios.

During my time in IT, I had to write a lot of documentation and I developed my own way of formatting instructions. This page is written to be a style guide, not only for myself, but for you, the reader, to better understand the articles.

Formatting / style explanations

You can expect my posts to follow the style guide below. If there are updates, they will be posted to this page.

UI elements to be clicked

When instructed to click a button or select an option, the title of the button/option will be listed in quotation marks and it will always be formatted the same way that it is listed on the screen.

Click “Enable”

Select “Users, Contacts, and Groups” from the dropdown.

Short strings to be typed

typeMeLikeThis

Long strings and code blocks

This is a long string.

{
    "message": "This is some JSON."
}

Sidenotes and warnings

A sidenote has information that you may want to pay attention to.

A warning has information to keep you from damaging systems, losing data, or making major mistakes.

Extra info

Expands will contain extra information that is not required in all scenarios, only applicable to advanced users, or generally unimportant to the article (though, some users may want to read it).

Last Updated: (10/15/2022)