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

added links to Compose release versions, improved matrix description #3580

Merged
merged 3 commits into from
Jun 13, 2017
Merged

added links to Compose release versions, improved matrix description #3580

merged 3 commits into from
Jun 13, 2017

Conversation

londoncalling
Copy link
Contributor

@londoncalling londoncalling commented Jun 12, 2017

What's new

  • Added links to Compose releases page
  • Clarified the relationship between Compose releases, Compose file format versions, and Docker Engine releases
  • Added a note about how to find information about old Docker versions, Compose releases, and file format versions

@friism @shin- and I discussed this, and we think it doesn't make sense to include such a detailed matrix for older versions of Docker and Compose releases, when that information is available in the release notes. So, what I did as a compromise was try to clarify how these releases and versions related, and suggest how to find details on particular releases in the release notes. I also surfaced the existing matrix a little more by giving it its own heading in the main file reference docs.

Related

Fixes #3404

Reviewers

@friism @shin- @Rots @mstanleyjones

Signed-off-by: Victoria Bialas [email protected]

@@ -7,7 +7,28 @@ This table shows which Compose file versions support specific Docker releases.

| **Compose file format** | **Docker Engine release** |
| ------------------- | ------------------ |
| 3.0 ; 3.1 | 1.13.0+ |
| 3.3 | 17.06.0+ |
| 3.0 - 3.2 | 1.13.0+ |
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add 2.2 as well? :)

| 2.1 | 1.12.0+ |
| 2.0 | 1.10.0+ |
| 1.0 | 1.9.1.+ |

In addition to Compose file format versions shown in the table, the Compose
product itself is on a release schedule, as shown in [Compose

Choose a reason for hiding this comment

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

Is "product" the right term?

1.10.0](https://github.com/docker/compose/releases/tag/1.10.0), and versioned
gradually in subsequent releases.

> Looking for more detail on Docker and Compose compatibility?

Choose a reason for hiding this comment

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

Should you bold this since it's kind of the note title?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's already bold .. I'll add links to the Netlify preview when this next set of changes builds, so that it's more obvious

However, if you are using an older version of Docker and want to determine which
Compose release is compatible, please refer to the [Compose release
notes](https://github.com/docker/compose/releases/). Each set of release notes
gives finer-tuned detail on which versions of Docker Engine are supported, along

Choose a reason for hiding this comment

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

Maybe s/gives finer-tuned detail on which/details which

@londoncalling
Copy link
Contributor Author

londoncalling commented Jun 13, 2017

@shin- @mstanleyjones okay check out this version, I used the {% include ... %} to add the matrix table in every file format reference (v1, v2, v3), and also incorporated most comments. Then also kept the table in the "Versioning and Upgrading" topic, but expanded on all the detailed stuff there.

Compose v3 file reference: https://deploy-preview-3580--docker-docs.netlify.com/compose/compose-file/

About versions and upgrading: https://deploy-preview-3580--docker-docs.netlify.com/compose/compose-file/compose-versioning/

Signed-off-by: Victoria Bialas <[email protected]>
@londoncalling
Copy link
Contributor Author

londoncalling commented Jun 13, 2017

Hey ya'll, merging this for now. Feel free to add more comments on this PR or re-open associated issue (#3404). Thanks for the reviews.

@londoncalling londoncalling merged commit 2cfb7ba into docker:master Jun 13, 2017
@londoncalling londoncalling deleted the compose-engine-matrix branch June 21, 2017 19:56
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.

3 participants