Skip to content

docs: Documentation analysis and improvement #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
github-actions wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: Documentation analysis and improvement #1017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion docs/workflows/oblt-aw-ingress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@ This is the reusable orchestration entrypoint for `oblt-aw`. It routes to specia
## Prerequisites

- Called by consumer workflows using `workflow_call`.
- Optional secret: `COPILOT_GITHUB_TOKEN`.
- Optional secrets:
- `COPILOT_GITHUB_TOKEN`
- `BUILDKITE_API_TOKEN` (used only by the `estc-pr-buildkite-detective` route)

## Usage

Expand Down Expand Up @@ -233,6 +235,7 @@ Top-level permissions (matches [.github/workflows/oblt-aw-ingress.yml](../../.gi
Interface exposed through `workflow_call`:

- Secret: `COPILOT_GITHUB_TOKEN` (`required: false`)
- Secret: `BUILDKITE_API_TOKEN` (`required: false`, used by `estc-pr-buildkite-detective`)

## Examples

Expand All @@ -246,6 +249,8 @@ jobs:
COPILOT_GITHUB_TOKEN: ${{ secrets.COPILOT_GITHUB_TOKEN }}
```

If you enable the `estc-pr-buildkite-detective` route, also map `BUILDKITE_API_TOKEN` from your consumer secret (commonly named `BUILDKITE_LOGS_API_TOKEN`).

## References

- [workflow-registry.json](../../config/obs/workflow-registry.json) (canonical Observability workflow ids for the Control Plane Dashboard; other orgs use `config/<org-key>/workflow-registry.json`)
Expand Down