docs: compose logs: add more links for flag descriptions#13833
Conversation
|
Actions are failing because some are not pinned; |
There was a problem hiding this comment.
Pull request overview
This PR updates the docker compose logs reference documentation to link individual flag entries (and their short forms where applicable) directly to the corresponding anchored sections in the upstream docker container logs CLI reference, now that those anchors exist.
Changes:
- Add per-flag
details_urlanchors forfollow,since,tail, andtimestampsin the Compose docs YAML. - Update the generated
compose_logs.mdoptions table so flags link to the anchored upstreamdocker container logssections. - Add/update
annotation.ExternalURLannotations for the corresponding flags incmd/compose/logs.goto match the anchored links.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/reference/docker_compose_logs.yaml | Adds anchored details_url entries for additional logs flags. |
| docs/reference/compose_logs.md | Updates generated options table links to point at anchored upstream references (incl. short flags). |
| cmd/compose/logs.go | Adds/updates annotation.ExternalURL for logs flags to use anchored upstream references. |
There was a problem hiding this comment.
Assessment: 🟢 APPROVE
This PR adds hyperlink annotations (ExternalURL) to four flags (--follow, --timestamps, --tail, and the existing --since/--until) in cmd/compose/logs.go, with corresponding updates to the generated Markdown and YAML reference docs.
All added URL anchors (#follow, #since, #timestamps, #tail) are consistent across the three changed files. No logic errors, formatting issues, or inconsistencies were found in the added lines.
|
@thaJeztah I will open a PR to fix the unpinned versions in workflows right now |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
Opened a PR to fix CI; |
|
@thaJeztah already merged, you can rebase your PR |
|
Oh! Missed your earlier comment 🙈 will rebase! |
follow-up to 7eeb7de, adding more links now that the CLI reference for docker logs has anchors for them. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
|
Hm... networking issues, or is it changes on our side blocking requests? |
follow-up to 7eeb7de, adding more links now that the CLI reference for docker logs has anchors for them.
What I did
Related issue
(not mandatory) A picture of a cute animal, if possible in relation to what you did