compose: update env file based on actual behavior #15759
Merged
Conversation
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
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.
✅ Deploy Preview for docsdocker ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify site settings. |
craig-osterhout
added
the
area/compose
aevesdocker
reviewed
Sep 28, 2022
Contributor
aevesdocker
left a comment
aevesdocker
left a comment
There was a problem hiding this comment.
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!
aevesdocker
approved these changes
Sep 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
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)