docs: Documentation analysis and improvement#1116
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1115
Summary of files analyzed
.github/remote-workflow-template/obs/.github/workflows/trigger-oblt-aw.yml.github/remote-workflow-template/obs/.github/workflows/oblt-aw.yml.github/remote-workflow-template/docs/.github/workflows/trigger-docs-aw.yml.github/remote-workflow-template/docs/.github/workflows/docs-aw.ymldocs/onboarding/README.mddocs/onboarding/adopting-agentic-workflows.mddocs/onboarding/registering-a-repository.mddocs/workflows/oblt-aw-client-template.mddocs/workflows/docs-aw-client-template.mdIssues found
docs/onboarding/README.md: Overview still described distributed per-workflowtrigger-oblt-aw-*.ymlmodel.docs/onboarding/adopting-agentic-workflows.md: Adoption flow and checklist referenced split per-workflow trigger files and removal ofoblt-aw.yml.docs/onboarding/registering-a-repository.md:workflow_refexamples and migration guidance referenced obsolete per-workflow trigger files; troubleshooting referenced outdated job name.docs/workflows/oblt-aw-client-template.md: Permission table listedactions: writeforoblt-aw.ymlingress, but template usesactions: read.docs/workflows/docs-aw-client-template.md: Permission table listedid-token: writefordocs-aw.yml, but template does not declare it.Changes made
docs/onboarding/README.mdto describe the unified observability client entrypoint model (trigger-oblt-aw.yml+oblt-aw.yml) so onboarding aligns with current distribution templates.docs/onboarding/adopting-agentic-workflows.mdto:trigger-oblt-aw.yml→oblt-aw.yml→oblt-aw-ingress.ymlflow,oblt-aw.yml) with removal of legacytrigger-oblt-aw-*.ymlfiles.docs/onboarding/registering-a-repository.mdto:workflow_refexamples toelastic/<repo>/.github/workflows/oblt-aw.yml@refs/heads/main,ingressjob naming.docs/workflows/oblt-aw-client-template.mdpermission matrix toactions: readforoblt-aw.ymlingress, matching template YAML.docs/workflows/docs-aw-client-template.mdpermission matrix to removeid-token: writefordocs-aw.yml, matching template YAML.These are doc-only, high-confidence updates grounded in current template workflow sources.
What is this? | From workflow: Observability Agentic Workflow Entrypoint
Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.