Commit Graph

42 Commits

Author SHA1 Message Date
David Karlsson
70d0c07c69 site: use content adapters for cli reference
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2026-02-24 08:01:05 +01:00
Quinn Redwoods
120b064895 docs: clarify depends_on short syntax does not wait for healthy services (#24144)
## Description

Clarifies that the `depends_on` short syntax does not wait for services
to become healthy, and waits only for them to be started (running).

This aligns with the long syntax section, which defines
`service_started` as equivalent to the short syntax, and with the
[Control startup and shutdown
order](https://docs.docker.com/compose/how-tos/startup-order/#control-startup)
manual:

> On startup, Compose does not wait until a container is "ready", only
until it's running.

Confirmed locally that short syntax behaves equivalently to `condition:
service_started`.

## Related issues or tickets

None

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [x] Technical review
- [x] Editorial review
- [ ] Product review
2026-02-17 14:57:47 +00:00
Allie Sadler
3415afac40 ENGDOCS-3132 (#23934)
<!--Delete sections as needed -->

## Description

As discussed before xmas, we will be removing opensource release note
pages and pointing users directly to the GitHub page

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2026-01-07 07:13:56 +00:00
David Karlsson
0220ef6745 chore: change mount path to work with postgres:18
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-12-04 11:08:14 +01:00
David Karlsson
9fe8e768d1 lint: add MD059/descriptive-link-text markdownlint rule
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2025-11-03 15:24:10 +01:00
Adam Monsen
610f6995ad Merge pull request #23633 from meonkeys/yaml-ish-envfile
document yaml-ish .env file syntax and spacing rules
2025-11-03 11:10:39 +01:00
Allie Sadler
9ab55eb18f compose: spec update (#23580)
<!--Delete sections as needed -->

## Description

https://github.com/compose-spec/compose-spec/pull/618

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-10-20 12:11:33 +01:00
Allie Sadler
4cc42b22ab Compose: pull_policy update (#23371)
<!--Delete sections as needed -->

## Description

adds https://github.com/compose-spec/compose-spec/pull/612

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-09-08 08:57:39 +01:00
Allie Sadler
078cf597c0 minor spec updates (#23213) 2025-08-08 08:17:09 +01:00
Allie Sadler
4c6f75f19f Compose spec freshness (#23029)
<!--Delete sections as needed -->

## Description
 
Voila

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-07-09 15:17:42 +01:00
Arthur
be57eec723 fix: code block (#23022) 2025-07-08 06:53:18 +02:00
Allie Sadler
6c5ecca0a4 Engdocs 2795 (#22961)
<!--Delete sections as needed -->

## Description

Adds Compose 2.38 content (includes some of the WAD updates - more
incoming)

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-07-01 10:19:17 +01:00
Allie Sadler
7b181005c3 Merge pull request #22882 from aevesdocker/ENGDOCS-2753
Compose: Spec attribute
2025-06-23 16:56:22 +01:00
bri
d84f2245e3 Merge pull request #22662 from b-/patch-1
Remove quotes from octal value in reference/compose-file/services.md
2025-05-27 08:06:40 +01:00
Allie Sadler
4fd64ac50b Compose: spec updates (#22655)
<!--Delete sections as needed -->

## Description

Spec updates on the new attributes released last week (plus some extra -
adds https://github.com/docker/compose/pull/12769 )

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-05-16 14:24:04 +01:00
Allie Sadler
12698a8d47 ENGDOCS-2553 (#22413)
<!--Delete sections as needed -->

## Description

Adds new `volume.type=image` to the spec

## Related issues or tickets

https://github.com/compose-spec/compose-spec/pull/585/files

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-04-11 16:08:30 +01:00
yinzhidong
7d8c6f14f3 update services.md (#22329)
<!--Delete sections as needed -->

## Description

<!-- Tell us what you did and why -->

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-03-31 08:45:24 +01:00
Bokyeom
7c9f78cda8 Fix typos and align with Docker/Compose specs (#22328)
## Description
- Fixed minor typos like `msyql`, `model`, `.json|`.
- Although `docker remove` works due to CLI fallback, it's not an
official command. Replaced with `docker rm` for correctness and clarity.
- Replaced `docker-compose.yml` with `compose.yaml` to align with the
[Compose
specification.](https://github.com/compose-spec/compose-spec/blob/main/03-compose-file.md)
2025-03-31 08:44:57 +01:00
Allie Sadler
4b21fc22d1 Merge pull request #22262 from aevesdocker/ENGDOCS-2489
ENGDOCS-2489
2025-03-17 15:10:36 +00:00
Allie Sadler
91676d373c CDI Compose support (#22131)
<!--Delete sections as needed -->

## Description

Adds https://github.com/compose-spec/compose-spec/pull/574

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-03-05 07:59:45 +00:00
Allie Sadler
a0b3a20b96 Merge pull request #22089 from aevesdocker/ENGDOCS-2437
ENGDOCS-2437
2025-02-24 15:32:37 +00:00
Allie Sadler
90824aed51 ENGDOCS-2429 (#22032)
<!--Delete sections as needed -->

## Description

Adds https://github.com/compose-spec/compose-spec/pull/569

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-02-14 08:21:02 +00:00
Allie Sadler
86b71d1dce ENGDOCS-2409 (#21963)
<!--Delete sections as needed -->

## Description

Spec updates:

Adds https://github.com/compose-spec/compose-spec/pull/563
Adds https://github.com/compose-spec/compose-spec/pull/558
Adds https://github.com/compose-spec/compose-spec/pull/565

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-02-06 08:30:20 +00:00
Sarah Sanders
9f56d945a7 chore: summary bar cleanup (#21887)
## Description
- Updated "Contribute" guide to reference summary bars, added
instructions for using them
- Removed `introduced` partial, this is now replaced by the summary bar
`requires` value
- Updated all files using `introduced` partial to use summary bar,
updated YAML file w/ feature name and info

## Related issues or tickets
[ENGDOCS-2392](https://docker.atlassian.net/browse/ENGDOCS-2392)

## Reviews
- [ ] Technical review
- [ ] Editorial review

[ENGDOCS-2392]:
https://docker.atlassian.net/browse/ENGDOCS-2392?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
2025-01-30 07:54:26 -08:00
Sarah Sanders
d083617e9d fix: update include.html for heading error (#21906)
## Description
- Problem: Some include shortcodes produce missing H3 ToC headings (ex:
https://docker.slack.com/archives/C039ZM6GH4Z/p1737545677728649)
- Fix: Update to include.html uses Hugo readFile function to fix parsing
errors and updated all include shortcodes using Find and Replace to use
correct syntax: `{{% "include-file" %}}`

## Related issues or tickets
-
[ENGDOCS-2398](https://docker.atlassian.net/browse/ENGDOCS-2398?atlOrigin=eyJpIjoiZGE3OTBmY2ExOTliNDVjY2JlOTc4Y2ViY2MwNDI3NDEiLCJwIjoiaiJ9)

## Reviews
- [ ] Technical review

[ENGDOCS-2398]:
https://docker.atlassian.net/browse/ENGDOCS-2398?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
2025-01-29 07:31:40 -08:00
Allie Sadler
f1a87f4fc0 ENGDOCS-2382 (#21848)
<!--Delete sections as needed -->

## Description

Some Compose spec updates:

Adds https://github.com/compose-spec/compose-spec/pull/557
Adds https://github.com/compose-spec/compose-spec/pull/555

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-01-23 15:51:21 +00:00
Allie Sadler
dc878e6cd1 ENGDOCS-2376 (#21797)
<!--Delete sections as needed -->

## Description

Updates Compose Spec with content in
https://github.com/compose-spec/compose-spec/pull/530
Also some freshness of the `ports` attribute

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-01-13 14:16:37 +00:00
Allie Sadler
bfd46ac620 ENGDOCS-2360 (#21725)
<!--Delete sections as needed -->

## Description

Looks larger than it is: - 

- A follow-up to comments on https://github.com/docker/docs/pull/21639
- Deals with hotjar issue
https://docker.slack.com/archives/C04BMTUC41E/p1734970724382829
- Vale freshness

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: Sarah Sanders <sarah.sanders@docker.com>
2025-01-07 17:12:17 +00:00
Sergii Boboshko
bb99e03904 Fix formatting 2024-12-26 00:31:24 +01:00
Jesper Noordsij
21b8b18974 Replace deprecated usage of : as separator in security_opt (#21642)
<!--Delete sections as needed -->

## Description

The usage of `:` as separator in security options was deprecated with
cb9aeb0413.
The preferred way of separating is using `=`.

## Related issues or tickets

N/A

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2024-12-18 08:54:52 +00:00
Allie Sadler
948b9cac9b ENGDOCS-2332 (#21639)
<!--Delete sections as needed -->

## Description

Adds new attributes to the spec from the recent 2.32.0 release

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2024-12-16 16:43:36 +00:00
Allie Sadler
aa68ba2627 ENGDOCS-2320 (#21463)
<!--Delete sections as needed -->

## Description

A few new Compose Spec additions 
https://docker.atlassian.net/browse/ENGDOCS-2320

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-20 08:55:44 +00:00
George Hopkins
57a2bb6ef2 Fix title level in Compose file reference 2024-11-08 12:19:09 +01:00
Allie Sadler
99a24c4a6b ENGDOCS-2300 (#21354)
<!--Delete sections as needed -->

## Description

Final PR to improve the DD IA. 

Validate test failing due to link that needs fixing in an upstream repo 

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review

---------

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-07 14:45:53 +00:00
Allie Sadler
66d0b9998e Engdocs 2282 (#21326)
<!--Delete sections as needed -->

## Description

Add lifecycle attributes to the compose spec

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [x] Editorial review
- [ ] Product review
2024-11-05 09:49:09 +00:00
Allie Sadler
93289fec4b ENGDOCS-2278 (#21256)
<!--Delete sections as needed -->

## Description

Closes https://github.com/docker/docs/issues/21247

## Related issues or tickets

<!-- Related issues, pull requests, or Jira tickets -->

## Reviews

<!-- Notes for reviewers here -->
<!-- List applicable reviews (optionally @tag reviewers) -->

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2024-10-29 09:43:27 +00:00
Allie Sadler
9d975a92a6 ENGDOCS-2228 (#20940)
* ENGDOCS-2228

* fix build

* title edits
2024-09-19 16:22:09 +01:00
gijoe88
a8cccaf82f permission mode of secrets in services must be quoted (#20850) 2024-09-13 08:40:35 +01:00
Allie Sadler
ef75c4af8d ENGDOCS-2213 (#20842) 2024-09-11 10:58:21 +01:00
David Karlsson
135870fc13 hugo: move manuals content to /manuals section
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-09 10:51:09 +02:00
David Karlsson
f01d6aefa9 compose: use real network driver_opts examples
The examples provided for network driver opts with compose only
demonstrated placeholder, fictitious options. This changes the examples
to show a realistic example for the bridge driver.

Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-19 14:50:01 +02:00
Allie Sadler
52b3d97da7 ENGDOCS-2184 (#20641)
* ENGDOCS-2184

* fix more links

* remove numbers from file names

* final link fix

* this is really the last fix
2024-08-19 11:45:34 +01:00