search

docker / docs

Source repo for Docker's Documentation
https://docs.docker.com
Apache License 2.0
4.13k stars 7.14k forks source link

Incomplete documentation for "restart: on-failure" in "Compose file reference / Services top-level element" #19115

Closed MovaUA closed 7 months ago

MovaUA commented 7 months ago

Is this a docs issue?

Type of issue

Information is incorrect

Description

The option on-failure of the restart actually supports specifying the optional maximum number of retries, but it is not mentioned on the site.

Location

https://docs.docker.com/compose/compose-file/05-services/#restart

Suggestion

The issue can be fixed by changing the documentation in Compose file reference / Services top-level element / restart section similar to what Docker Engine / Containers/ Docker run reference / Restart policies (--restart) section says.

MovaUA commented 7 months ago

A PR is published to resolve the issue - see the PR #19116

docker-robot[bot] commented 4 months ago

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