Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 49 additions & 0 deletions docs/index.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# 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
27 changes: 27 additions & 0 deletions ownership.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
version: 1
ownership:
- name: docs-internal
long_name: GitHub Docs
kind: logical
repo: https://github.com/github/docs-internal
team: github/docs
maintainer: tinabme
exec_sponsor: martinwoodward
product_manager: emilyistoofunky
qos: critical
dependencies: []
tier: 2
sev1:
pagerduty: https://github.pagerduty.com/escalation_policies#PN57VQ1
slack: docs-alerts
issue: https://github.com/github/docs-team/issues
tta: '30 min'
sev2:
slack: docs-alerts
issue: https://github.com/github/docs-team/issues
tta: '1 business day'
sev3:
slack: docs-alerts
issue: https://github.com/github/docs-team/issues
tta: '1 week'