Onboarding Guide

A modern, self-hosted knowledge base designed for teams to organize and collaborate on internal documentation, product specs… — source: github.com/outline/outline
Simulated demo
DB
Engineering · edited 2 days ago by Priya N.

Onboarding Guide

Welcome to the team! This doc walks through account setup, your first pull request, and where to find things.

1. Accounts & access

You should have received invites to GitHub, Slack, and the internal wiki. If anything is missing, ping #it-support.

  • GitHub organization access
  • VPN / SSO via authentik
  • Staging environment credentials

2. Your first pull request

Clone the monorepo, run make setup, and pick up a good-first-issue-labeled ticket from the board.

Tip: pair with your onboarding buddy for the first PR — it's the fastest way to learn our review conventions.

3. Where things live

WhatWhere
Source codeGitHub org
Design filesFigma workspace
Incidents#incidents Slack channel
Engineering · edited 1 week ago by Marcus T.

API Conventions

All internal APIs follow REST conventions with JSON payloads and cursor-based pagination.

Naming

Resources are plural nouns: /orders, /customers. Actions that don't map to CRUD use a verb suffix: /orders/:id/cancel.

Errors

Every error response includes a stable code field clients can branch on, plus a human-readable message.

Engineering · edited yesterday by Lena K.

On-call Runbook

Step-by-step response for the most common paging alerts.

High error rate

  1. Check the status dashboard for a correlated deploy.
  2. If a deploy correlates, roll back first, investigate after.
  3. Post an update in #incidents within 10 minutes.
Company · edited 3 weeks ago by People Ops

Employee Handbook

Policies, benefits, and how we work together. This is the living source of truth for company-wide processes.

📄 Onboarding Guide
📄 API Conventions
📄 On-call Runbook
📄 Employee Handbook