50 lines
1.9 KiB
YAML
50 lines
1.9 KiB
YAML
# This stuff ends up here: https://catalog.githubapp.com/services/help-docs/docs
|
|
|
|
version: 1
|
|
links:
|
|
- name: Observability docs
|
|
description: Docs Engineering observability docs
|
|
kind: docs
|
|
service: docs-internal
|
|
url: https://github.com/github/docs-engineering/blob/main/docs/observability/docs.github.com.md
|
|
- name: Datadog dashboard
|
|
description: Production Datadog dashboard
|
|
kind: dashboard
|
|
service: docs-internal
|
|
url: https://app.datadoghq.com/dashboard/8uc-x67-tgi/help-docs
|
|
- name: Sentry dashboard
|
|
description: Production Sentry dashboard
|
|
kind: dashboard
|
|
service: docs-internal
|
|
url: https://sentry.io/organizations/github/issues/?project=5394325
|
|
- name: Help Docs playbook
|
|
description: How to respond to Help Docs Alerts
|
|
kind: playbook
|
|
service: docs-internal
|
|
url: https://github.com/github/docs-engineering/blob/main/docs/playbooks/docs/index.md
|
|
- name: Maintaining the deployment
|
|
description: Document describing the production deployment and how to troubleshoot it.
|
|
kind: docs
|
|
service: docs-internal
|
|
url: https://github.com/github/docs-internal#deployments
|
|
- name: PagerDuty escalation policy
|
|
description: Escalation policy and on-call schedule for incident response
|
|
kind: tool
|
|
service: docs-internal
|
|
url: https://github.pagerduty.com/schedules#PSTWXGP
|
|
- name: Feature docs
|
|
description: Docs describing a few key features of Help Docs
|
|
kind: docs
|
|
service: docs-internal
|
|
url: https://github.com/github/docs-engineering/tree/main/docs
|
|
- name: Technical architecture
|
|
description: This document covers the technical architecture of Help Docs
|
|
kind: docs
|
|
service: docs-internal
|
|
url: https://github.com/github/docs-internal#readmes
|
|
- name: Spin up locally
|
|
description: How to setup Help Docs on your local machine
|
|
kind: docs
|
|
service: docs-internal
|
|
url: https://github.com/github/docs-internal#developing
|