https://github.com/pagerduty/developer-docs
PagerDuty's developer documentation
https://github.com/pagerduty/developer-docs
team-authentication-and-authorization
Last synced: 2 months ago
JSON representation
PagerDuty's developer documentation
- Host: GitHub
- URL: https://github.com/pagerduty/developer-docs
- Owner: PagerDuty
- Created: 2021-04-28T17:32:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-06T17:29:22.000Z (3 months ago)
- Last Synced: 2025-03-11T13:05:07.919Z (2 months ago)
- Topics: team-authentication-and-authorization
- Homepage: https://developer.pagerduty.com/docs
- Size: 4.16 MB
- Stars: 12
- Watchers: 78
- Forks: 15
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Developer Docs
This repo contains the docs that are hosted at: [developer.pagerduty.com/docs](https://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 #shaf-shared 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](stoplight.io) provides to us.
- [Markdown Formatting](https://www.markdownguide.org/basic-syntax/)
- [Stoplight Markdown]( https://meta.stoplight.io/docs/studio/docs/Documentation/03a-stoplight-flavored-markdown.md)
## 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.](https://meta.stoplight.io/docs/platform/4.-documentation/d.table-of-contents.md)
## 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.