Skip to content

Commit f339893

Browse files
authored
Expand README for src/github-apps (#58903)
1 parent fe49706 commit f339893

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

src/github-apps/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,25 @@ Slack: `#docs-engineering`
6868
Repo: `github/docs-engineering`
6969

7070
If you have a question about the GitHub Apps pipeline, you can ask in the `#docs-engineering` Slack channel. If you notice a problem with the GitHub Apps pipeline, you can open an issue in the `github/docs-engineering` repository.
71+
72+
## Ownership & On-call
73+
74+
### Ownership
75+
- **Team**: Docs Engineering
76+
- **Source data**: API Platform team (github/rest-api-description)
77+
78+
### On-call procedures
79+
If the GitHub Apps pipeline fails:
80+
1. Check workflow logs in `.github/workflows/sync-openapi.yml`
81+
2. Verify access to `github/rest-api-description` repo
82+
3. Check for OpenAPI schema changes
83+
4. Escalate to #docs-engineering if stuck
84+
5. Contact API Platform team for source data issues
85+
86+
### Monitoring
87+
- Pipeline runs automatically on schedule (shared with REST/Webhooks)
88+
- PRs created with `github-openapi-bot` label
89+
- Failures visible in GitHub Actions
90+
- SHA tracking in `config.json` for version history
91+
92+
We are not expecting further significant development on this pipeline. We will continue to support incoming changes from the rest-api-description.

0 commit comments

Comments
 (0)