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

Add documentation for --menu up option and COMPOSE_MENU environment var #11800

Merged
merged 1 commit into from
May 7, 2024

Conversation

jhrotko
Copy link
Contributor

@jhrotko jhrotko commented May 7, 2024

What I did
Added documentation related to recent added option in up command to enable/disable the helper menu in detach mode.
Seems like this information was lacking in our documentation and some users were confused on how to enable/disable the menu.

Related issue
relates to docker/for-win#14021
https://docker.atlassian.net/browse/COMP-540

(not mandatory) A picture of a cute animal, if possible in relation to what you did
image

Copy link
Contributor

@milas milas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tiny copy fixes but LGTM

docs/reference/compose.md Outdated Show resolved Hide resolved
Comment on lines 121 to 122
Setting the `COMPOSE_MENU` environment variable to `false` disabled the helper menu when running `docker compose up`
in detached mode. Alternatively, you can also run `docker compose up --menu=false` to disable the helper menu.
Copy link
Contributor

@milas milas May 7, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Setting the `COMPOSE_MENU` environment variable to `false` disabled the helper menu when running `docker compose up`
in detached mode. Alternatively, you can also run `docker compose up --menu=false` to disable the helper menu.
Setting the `COMPOSE_MENU` environment variable to `false` disables the helper menu when running `docker compose up`
in attached mode. Alternatively, you can also run `docker compose up --menu=false` to disable the helper menu.

@milas milas added the kind/docs label May 7, 2024
@jhrotko jhrotko force-pushed the add-docs-up-menu branch 3 times, most recently from 1cc7308 to 6677d7b Compare May 7, 2024 13:12
@ndeloof ndeloof enabled auto-merge (rebase) May 7, 2024 13:14
…ariable

Co-authored-by: Milas Bowman <devnull@milas.dev>
Signed-off-by: Joana H <joana.hrotko@gmail.com>
Signed-off-by: Joana Hrotko <joana.hrotko@docker.com>
@jhrotko jhrotko requested review from ndeloof and milas May 7, 2024 13:30
@ndeloof ndeloof merged commit b816241 into docker:main May 7, 2024
29 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants