Skip to content
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.

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

Link to configuration file docs #12559

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

andrew-kramer
Copy link

What I did
Added a link from the compose command docs to the config file docs to improve clarity and ease of finding related docs.

Related issue
Closes #12526

A lynx:
220px-Lynx_lynx_poing-1084623192

@andrew-kramer andrew-kramer requested a review from a team as a code owner February 17, 2025 15:16
Signed-off-by: Andrew Kramer <[email protected]>
@andrew-kramer andrew-kramer force-pushed the 12526-compose-file-link branch from 08b34d3 to d5327a9 Compare February 17, 2025 15:20
@ndeloof
Copy link
Contributor

ndeloof commented Feb 20, 2025

Please apply such change to the flag definition in go code (cmd/compose/compose.go) then run make docs

@glours
Copy link
Contributor

glours commented Feb 20, 2025

Thanks for the PR, @aevesdocker Compose Technical writer is looking to make a global PR to address all such potential inconsistency in the command flags.

@andrew-kramer
Copy link
Author

andrew-kramer commented Feb 20, 2025

Please apply such change to the flag definition in go code (cmd/compose/compose.go) then run make docs

I'm happy to do that, but the Go code already has all the text. This PR was just to add a link, which I think the Go code wouldn't include.

Sorry, I might well be misunderstanding the request or missing something in the code. This is my first PR here, which is why I chose something minuscule.

Never mind. I found what you mean. I'll have that very shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Compose file reference seems very hidden in help file and not to be found from starting page
3 participants