# slate_apm_help

**Repository Path**: mirrors_adamchainz/slate_apm_help

## Basic Information

- **Project Name**: slate_apm_help
- **Description**: Scout APM Help docs
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-09-24
- **Last Updated**: 2025-11-22

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Scout APM Help Docs

This is the helpsite for Scout APM. It's built using Slate and hosted on Github pages. It's accessible via a CNAME @ https://docs.scoutapm.com.

## Requirements

Ruby 2.2.2 or greater.

## Installation

Just run `bundle`.

## Making changes

* Start the server: `bundle exec middleman server`
* Commit, Push
* Deploy: `bundle exec rake publish` => updates the `gh-pages` branch with the build.

## Gotchas

### Duplicate header names

The toc generation and anchorjs dont' handle duplicate header names well. If you create a duplicate header, specify a unique element id:

```
<h3 id="elixir-testing-instrumentation">Testing instrumentation</h3>
```

### Upgrading

Note that Slate is not a Ruby gem: it's a GitHub repo that we fork that includes gems and assets.