Skip to content

Docs

Getting started

Three steps from an empty workspace to your first approved note.

  1. 1. Connect a repository

    In Settings, under Repositories, choose GitHub, GitLab or Bitbucket, then the repository and the branch you ship from.

  2. 2. Choose who approves

    Add at least one approver. Only an approver can send a note to the public.

  3. 3. Merge something

    The next pull request merged into that branch waits in the queue as a draft. Edit it, press Approve, and it goes out on your publishing day.

A settings file, if you like

You can keep the settings in the repository, in a petek.yml file. Petek reads it and never writes to it.

# petek.yml
branch: main
approvers: [maya, tom]
publish: tuesday
languages: [en, he]

This is a sample of the docs; the full docs live inside the product.