Developer Docs
This repo contains the docs that are hosted at: developer.pagerduty.com/docs
Contributing
Everyone is encouraged to write and modify Developer Docs. Simply edit the files and open a pull request.
Staging (for PD employees)
This repository has a staging environment so you can see the changes before pushing them up to our production website. If you'd like to see the changes there first, simply click the "Buildkite" step in your Pull Request and unblock the deploy step.
Ownership
These docs are owned by the #dev-foundations team and they will review and deploy any changes made- simply ask them via Slack when you open a pull request.
Markdown
The docs are written in simple markdown format with some flavour on top that Stoplight provides to us.
Editing the "Sidebar"/Table of Contents
Documents are hidden by default, to provide a link to a document via the Table of Contents you must edit the Table of Contents file: toc.json
Documentation on how toc.json
works can be found here.
File Naming
There isn't a strict file naming convention. However, files have broadly been organized into 'topic' folder, and file names begin with the order they appear in the Table of Contents.
Deployment
Simply merging to the main
branch will deploy docs to production.