Index ¦ Archives ¦ Atom ¦ RSS

Documentation Style Guide

I just wrote up a style guide for our team's documentation. The documentation is rendered using Gitbook and hosted on Github Pages. You can find the PR here but I figured it's worth sharing here as well.

Style Guide

Articles should be written in Markdown (not AsciiDoc). Markdown ...


Beer and Probes

Quick post to clear up some terminology. But first, an analogy to clear up my thinking:

Analogy

Temperature control is a big part of brewing beer. Throughout the brewing process I use a thermometer to measure the temperature of the soon-to-be beer. Because I take several temperature readings throughout the ...


Bad Tools are Insidious

This is my first job making data tools that other people use. In the past, I've always been a data scientist - a consumer of these tools. I'm learning a lot.

Last quarter, I learned that bad tools are often hard to spot even when they're damaging productivity ...


Literature Review: Writing Great Documentation

I’m working on a big overhaul of my team’s documentation. I’ve noticed writing documentation is a difficult thing to get right. I haven’t seen any great example for a data product, either. I don’t have much experience in this area, so I decided to review ...


Is moving to the Bay Area worth it?

I came across this article on the front page of Hacker News yesterday. The author argues that Bay Area housing prices may be high, but the salary increase probably makes it worth while. The author pulls together some interesting data to make their point, but I have major issues with ...


Announcing the Cross Sectional Dataset

I'm happy to announce a new telemetry dataset!

The Cross Sectional dataset makes it easy to describe our users by providing summary statistics for each client. Like the Longitudinal table, there's one row for each client_id in a 1% sample of clients. However, the Cross Sectional dataset simplifies ...


Meta Documentation

You'll see a lot of posts coming down the line on documentation.

We surveyed our customers last quarter and asked where our data pipeline was lacking. It turns out the most painful part of using our data pipeline, is reading the documentation. I've been interesting in learning how ...


Why Markdown?

Last week I finished a pull request that moved some documentation from mozilla's wiki to a github repository. It took a couple of hours of editing and toying with pandoc to get right ...


Working over SSH

Introduction

Working over SSH can be impossibly frustrating if you're not using the right tools. I promised my teammates a write-up how I work over ssh. Using these tools will make it significantly easier / more fun to work with a remote linux ...


Strange Spark Error

Introduction

I spend the better part of last week debugging a Spark error, so I figure it's worth writing up.

The Bug

I added the this very simple view to our batch views repository.

package com.mozilla.telemetry.views

import org.apache.spark.{SparkConf ...

© Ryan T. Harter. Built using Pelican. Theme by Giulio Fidente on github.