search

Handbook

About the handbook

The Fleet handbook is inspired by (and heavily influenced by) the GitLab team handbook. It shares the same advantages and will probably undergo a similar evolution.

While this handbook is inspired by GitLab's handbook, it is nowhere near as complete (yet!) We will continue to add and update information in this handbook, and gradually migrate information from Fleet's shared Google Drive folder as time allows.

Handbook style guide

Headings

Headings help readers scan content to easily find what they need. Organize page content using clear headings, specific to the topic they describe.

Keep headings brief and organize them in a logical order:

  • H1: Page title
  • H2: Main headings
  • H3: Subheadings
  • H4: Sub-subheadings (headings nested under subheadings)

Try to stay within 3 or 4 heading levels. Complicated documents may use more, but pages with a simpler structure are easier to read.

Contributing to the handbook

To contribute to a handbook page:

  1. Click "Edit this page"
  2. Make your changes in the browser. (The language is markdown.)
  3. Click "Propose changes"
  4. Request a reviewer by clicking the gear and picking only one. Choose the reviewer whose face is on the handbook page when you view it on fleetdm.com
  5. Click "Create pull request".

All done!