Skip to content

compose: update env file based on actual behavior - #15759

Merged
aevesdocker merged 3 commits into
docker:masterfrom
milas:compose-env-file
Sep 28, 2022
Merged

compose: update env file based on actual behavior#15759
aevesdocker merged 3 commits into
docker:masterfrom
milas:compose-env-file

Conversation

@milas

@milas milas commented Sep 27, 2022

Copy link
Copy Markdown
Contributor

Proposed changes

There has been a LOT of work on this area in Compose recently. As part of this, we discovered that the documentation has been incorrect for some time. That is, the documented behavior has often never been indicative of reality (across both v1 and v2).

We've standardized and cleaned things up, so the documentation now reflects current behavior. The Compose Spec requires similar corrections/reconciliation, but we're starting here to ensure that the more user-facing docs are in a good place.

Related issues (optional)

There has been a LOT of work on this area in Compose recently.
As part of this, we discovered that the documentation has been
incorrect for some time. That is, the documented behavior has
often never been indicative of reality (across both v1 and v2).

We've standardized and cleaned things up, so the documentation
now reflects current behavior. The Compose Spec requires similar
corrections/reconciliation, but we're starting here to ensure
that the more user-facing docs are in a good place.
@netlify

netlify Bot commented Sep 27, 2022

Copy link
Copy Markdown

Deploy Preview for docsdocker ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 517ff23
🔍 Latest deploy log https://app.netlify.com/sites/docsdocker/deploys/6334050afc2b62000855b94c
😎 Deploy Preview https://deploy-preview-15759--docsdocker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@craig-osterhout craig-osterhout added the area/compose Relates to docker-compose.yml spec or docker-compose binary label Sep 27, 2022

@aevesdocker aevesdocker left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @milas! Added two picky review comments, which I've already committed and merged so as to amend the docs asap!

I think it would be worth exploring a different way to display this information. Perhaps some of the points could have tables with a 'Correct' column and an 'incorrect' column, which might make things clearer. But this is certainly not a priority for now!

Comment thread compose/env-file.md Outdated
Comment thread compose/env-file.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/compose Relates to docker-compose.yml spec or docker-compose binary

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants