Skip to content

[oblt-aw][autodoc] Fix docs drift in detector trigger and multi-org migration status #833

@github-actions

Description

@github-actions

cc @elastic/observablt-ci

Recent documentation audit found concrete drift between docs and current source behavior.

Changes Requiring Documentation Updates

1. Resource-not-accessible detector trigger is documented incorrectly

What changed / evidence:

  • docs/workflows/gh-aw-resource-not-accessible-by-integration-detector.md:24 says the detector runs via ingress schedule or workflow_dispatch.
  • .github/workflows/oblt-aw-ingress.yml:125-127 routes resource-not-accessible-by-integration-detector only when github.event_name == schedule.

Documentation impact:

  • Update docs/workflows/gh-aw-resource-not-accessible-by-integration-detector.md to reflect actual ingress routing (schedule only), or clearly distinguish direct invocation from ingress routing.

2. Multi-org architecture doc contains contradictory migration-state guidance

What changed / evidence:

  • docs/architecture/multi-org-agentic-workflows.md:3,7 states the config/<org-key>/ layout and 3-part marker format are implemented.
  • The same document still says updates are required:
    • docs/architecture/multi-org-agentic-workflows.md:47 (“Regex and tests ... must be updated ...”)
    • docs/architecture/multi-org-agentic-workflows.md:129-133 migration steps to refactor parser/gating.
  • Current code already implements 3-part markers and org:workflow-id handling:
    • scripts/common.py:133-149
    • scripts/sync_control_plane_dashboard.py:79-94
    • scripts/get_enabled_workflows.py:78-83

Documentation impact:

  • Update docs/architecture/multi-org-agentic-workflows.md to remove/replace stale “must be updated” migration language and clearly separate historical migration notes from current state.

Suggested Actions

  • In docs/workflows/gh-aw-resource-not-accessible-by-integration-detector.md, correct the trigger text so ingress behavior matches .github/workflows/oblt-aw-ingress.yml.
  • In docs/architecture/multi-org-agentic-workflows.md, reconcile the “implemented” status with migration sections so contributors are not told to perform already-completed work.

What is this? | From workflow: Observability Agentic Workflow Entrypoint

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on May 16, 2026, 7:02 AM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions