docs icon indicating copy to clipboard operation
docs copied to clipboard

the version property is deprecated

Open ver-alex opened this issue 3 years ago • 1 comments

File: get-started/08_using_compose.md

The top-level attribute version is marked as DEPRECATED since beginning of 2021 and should be removed from the example of the compose documentation.

https://github.com/compose-spec/compose-spec/commit/85d1bcfc07462fbfc645882a4ca1901012075cf6

ver-alex avatar Oct 14 '22 13:10 ver-alex

@ver-alex Would it be a good practice if we remove everything that includes about version?

nitishfy avatar Oct 14 '22 15:10 nitishfy

I think it is confusing to use a deprecated attribute and should be removed. Version is not used anymore if you are on a recent and updated version of docker compose.

As the compose spec describes this here: https://github.com/compose-spec/compose-spec/blob/master/spec.md#version-top-level-element

Top-level version property is defined by the specification for backward compatibility but is only informative.

A Compose implementation SHOULD NOT use this version to select an exact schema to validate the Compose file, but prefer the most recent schema at the time it has been designed.

ver-alex avatar Oct 17 '22 07:10 ver-alex

@ver-alex How about we change the version of docker-compose to the latest version?

nitishfy avatar Oct 29 '22 11:10 nitishfy

Since the version element is (or should not be) used by the compose parser it has no functionality and is not a necessary part in a compose file anymore. I would just remove it. Guess that over time no compose files will have the version property. Also, since no version is stated, the documentation will not become outdated 😉.

ver-alex avatar Nov 07 '22 11:11 ver-alex

Would you mind raising a PR for this issue? Reviewers would be happy to see the changes you make.

nitishfy avatar Nov 09 '22 06:11 nitishfy

There hasn't been any activity on this issue for a long time. If the problem is still relevant, mark the issue as fresh with a /remove-lifecycle stale comment. If not, this issue will be closed in 14 days. This helps our maintainers focus on the active issues.

Prevent issues from auto-closing with a /lifecycle frozen comment.

/lifecycle stale

docker-robott avatar Feb 07 '23 01:02 docker-robott

Closed issues are locked after 30 days of inactivity. This helps our team focus on active issues.

If you have found a problem that seems similar to this, please open a new issue.

/lifecycle locked

docker-robott avatar Mar 25 '23 03:03 docker-robott