Commit Graph

67 Commits

Author SHA1 Message Date
Allie Sadler 4fe971a0d5
ENGDOCS-2505 (#22323)
<!--Delete sections as needed -->

## Description

addresses 404 issues
https://docs.google.com/spreadsheets/d/1yjQsYd-uBEuPaEZFRfuFbkla1xn7UBnIkfCJp8DcxYM/edit?gid=0#gid=0

## 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-27 13:44:58 +00:00
Guillaume Lours f54284dfb1
correct compose down example with profile (#22278)
The down command used with profile will stop the services with a given
profile but also all the services without any profiles

## Description
Correct the section of stopping services with a specific profile in the
how-to profile documentation page

## Related issues or tickets
https://github.com/docker/compose/issues/12648
## Reviews

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

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

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2025-03-19 11:10:09 +00:00
Guillaume Lours 763a789428
Merge pull request #22240 from glours/compose-oci-artifact
add Compose OCI artifact how-to page
2025-03-17 10:20:03 +00:00
Guillaume Lours 60d67ab25b
release-notes for Compose v2.34.0 version (#22244)
## Description
Add release notes for Compose `v2.34.0` release

## Related issues or tickets
https://docker.atlassian.net/browse/APCLI-1034

## Reviews

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

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

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-03-14 11:16:58 +00:00
Nicolas De loof e396af2358
some clarification on additional_contexts (#22204)
## Description

some clarification as requested on
https://github.com/docker/compose/issues/8538#issuecomment-2707487495

## Related issues or tickets

## Reviews

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

---------

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-03-10 10:00:09 +00:00
Veesh Goldman 006608da5b
Update release-notes.md (#22143)
`x-initialSync` was misspelled as `x-initSync`, which can be frustrating
for users. Ref
876ecc48be/pkg/compose/watch.go (L170)
and
https://github.com/docker/compose/issues/11102#issuecomment-2327505438
2025-03-03 14:45:12 +00:00
Ville Skyttä 4693262586
Merge pull request #22135 from scop/docs/manuals-compose-yaml
docs(manuals): use canonical compose.yaml filename
2025-03-03 09:23:00 +00:00
Guillaume Lours acb8d12b7b
release-notes for Compose v2.33.1 version (#22077)
<!--Delete sections as needed -->

## Description
Add release note for the latest `v2.33.1` release of Compose
<!-- 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
- [x] Editorial review
- [ ] Product review

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-02-24 10:13:17 +00:00
Vegard Lillesalt Valvik 115be657f1
Fix small typo (#22073)
Fix typo, "fore" -> "for"
2025-02-21 08:03:20 -08:00
Nicolas De loof da13512a3d
Bump compose v2.33.0 (#22025)
## Description

Bump compose to v2.33.0

## Related issues or tickets

https://docker.atlassian.net/browse/APCLI-966

## Reviews

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

---------

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-02-13 13:32:49 +00:00
Allie Sadler 4e1eb2942a
add shortcode (#21972)
<!--Delete sections as needed -->

## Description

Adds shortcode and renames the page (have not added an alias as the page
has been live for less than 24 hours so does not need one)

## 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:33 +00:00
Nicolas De loof 64b1d41c96
document support for services reference as additional_contexts (#21941)
## Description

document support for `services:xx` syntax in additional_contexts

## Related issues or tickets

https://docker.atlassian.net/browse/APCLI-928

## Reviews

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

---------

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-02-04 15:34:59 +00:00
Plain 01a0f9718d
Update file-watch.md: add ignore attribute path (#21820)
## Description

I added some explanation about the `ignore` attribute in the watch rule.
I noticed the document says:

> All paths are relative to the project directory

However, when I deployed it in my project, I found that my container was
rebuilding crazily based on the action I defined.

After testing, I discovered that the `ignore` path is actually relative
to the `path` defined in the same `watch` rule, not the project
directory. I also confirmed this with the AI on the Docker Docs website.

This PR updates the documentation to clarify this behavior.

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
Co-authored-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2025-02-03 08:46:59 +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
Sarah Sanders 3de8201822
implement summary bars for feature attributes (#21667)
## Description
- Create `summary-bar.html` shortcode
- Inline styling

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

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

[ENGDOCS-2333]:
https://docker.atlassian.net/browse/ENGDOCS-2333?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

Preview:
https://deploy-preview-21667--docsdocker.netlify.app/security/for-admins/hardened-desktop/settings-management/configure-admin-console/

[ENGDOCS-2334]:
https://docker.atlassian.net/browse/ENGDOCS-2334?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
2025-01-21 09:19:16 -08:00
Guillaume Lours d7f4f4b05b
release-notes for Compose v2.32.4 version (#21832)
add a note about the version issue in v2.32.3

<!--Delete sections as needed -->

## Description

Add release notes of Compose v2.32.4

## Related issues or tickets
https://docker.atlassian.net/browse/COMP-909

## Reviews

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

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

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-01-16 10:05:41 +00:00
Guillaume Lours ff148d0cef
release-notes for Compose v2.32.3 version (#21800)
<!--Delete sections as needed -->

## Description
Add release notes for Compose `v2.32.3` release

## Related issues or tickets
https://docker.atlassian.net/browse/COMP-904

## Reviews

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

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

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-01-13 15:07:58 +00:00
Allie Sadler e6139394c7
ENGDOCS-2365 (#21728)
<!--Delete sections as needed -->

## Description

Small clarity addition. Addresses
https://github.com/docker/docs/issues/21151?reload=1

## 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-08 08:23:45 +00:00
Guillaume Lours ececfa948c
release-notes for Compose v2.32.2 version (#21726)
<!--Delete sections as needed -->

## Description
Add release notes of Compose `v2.32.2` version
<!-- Tell us what you did and why -->

## Related issues or tickets
https://docker.atlassian.net/browse/COMP-868
<!-- 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

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2025-01-07 16:53:02 +00:00
Sergii 14761738ce
fix: square brackets (#21698)
<!--Delete sections as needed -->

## Description

I updated the heading to replace <project directory> with the
HTML-escaped equivalent &lt;project directory&gt;. This change ensures
proper rendering on the web version of the site, where raw HTML don't
display correctly..

## Reviews

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

- [ ] Editorial review

Co-authored-by: Sergii Boboshko <sergii.boboshko@henesis.eu>
2025-01-06 09:51:12 +00:00
Nicolas De loof 9736a4bb95
Bump compose to v2.32.0 (#21626)
## Description

Bump compose to v2.32.0

## Related issues or tickets

## Reviews

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

---------

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2024-12-16 08:58:26 +00:00
Artfaith b8aaf24f2c
Update envvars.md (#21627)
Dear Community and Developers,

Thank you heartfelt for the marvel you do...

---

Fixed a tiny typo, ~~making the strict "Director" to not watch closely
the directory but having their own business~~.

---

Best and kind regards 
2024-12-13 16:17:38 +00:00
Allie Sadler 0c71c3b245
ENGDOCS-2341 (#21556)
<!--Delete sections as needed -->

## Description

Compose 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
2024-12-04 08:40:22 +00:00
rohanborate6713 95cb86f173
Update standalone.md (#20985)
updated missing command for the second point where executable permission
is required for the standalone binary

<!--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

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2024-12-02 10:17:06 +00:00
Guillaume Lours 95b8aee0eb
release-notes for Compose v2.31.0 version (#21524)
<!--Delete sections as needed -->

## Description
Add release notes for Compose `v2.31.0`

## Related issues or tickets
https://docker.atlassian.net/browse/COMP-832


## Reviews

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

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

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2024-11-28 15:55:46 +00:00
David Karlsson 8a722e7ee1
Merge pull request #21474 from dvdksn/sidebar-grouping
feat: sidebar groups
2024-11-28 16:46:15 +01:00
David Karlsson b98c303498 chore: add sidebar groups to top-level pages in manuals section
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-26 13:49:53 +01: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
Anthony Dempsey b47eea68cd
Update gettingstarted.md to use f-string
Python's f-strings are the preferred method of string formatting now. Updated the python code examples to use them instead of .fromat()
2024-11-17 16:17:23 +00:00
Sarah Sanders 3709b9bab5
Merge branch 'main' into ENGDOCS-2281 2024-11-13 09:38:26 -08:00
Allie Sadler 371db0ad99
ENGDOCS-2315 (#21416)
<!--Delete sections as needed -->

## Description

Standardize overview pages

## 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-11-13 10:19:19 +00:00
Sarah Sanders 363d194cac
Merge branch 'main' into ENGDOCS-2281 2024-11-11 14:59:50 -08:00
Sarah Sanders 8b81c215db Found more outdated callouts, fixed whitespacing 2024-11-08 10:32:44 -08:00
Sarah Sanders be328b9958 Update all outdated callouts 2024-11-08 10:31:58 -08:00
David Karlsson 64736e4c39 style: s/distro/distribution/g
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-11-08 16:47:05 +01:00
Guillaume Lours efe6a80467
release-notes for Compose v2.30.3 version
Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2024-11-07 23:17:12 +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
Guillaume Lours b6f336d045
release-notes for Compose v2.30.2 version (#21345)
<!--Delete sections as needed -->

## Description
Add release notes of Compose `v2.30.2` version
<!-- 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
- [x] Editorial review
- [ ] Product review

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2024-11-06 14:15:34 +00:00
Kevin Kortum 796397304a
Update merge.md (#21340)
Stick with the preferred version of compose files according to
https://docs.docker.com/compose/intro/compose-application-model/#the-compose-file

<!--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
2024-11-05 14:55:02 +00:00
Allie Sadler 502e61c960
ENGDOCS-2298 (#21339)
<!--Delete sections as needed -->

## Description

More DD IA improvements. Moves troubleshooting, faqs, support, and other
misc. pages.

## 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-11-05 14:03:52 +00:00
Allie Sadler 3ea0cd758d
ENGDOCS-2283 (#21329)
<!--Delete sections as needed -->

## Description

Tidy up of DD IA. Creates a 'setup' folder and moves relevant pages
within it. First PR of a few

## 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-11-05 10:07:48 +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
Guillaume Lours da6b081cc4
release-notes for Compose v2.30.1 version (#21280)
<!--Delete sections as needed -->

## Description
Add release notes of Compose `v2.30.1` version
<!-- 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
- [x] Editorial review
- [ ] Product review

---------

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2024-10-30 11:10:30 +00:00
Nicolas De loof 9fed920ed1
lifecycle hooks (#21061)
## Description

documentation for https://github.com/docker/compose/pull/12166

## Related issues or tickets

[<!-- Related issues, pull requests, or Jira tickets
-->](https://docker.atlassian.net/browse/COMP-760)

## Reviews

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

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
2024-10-29 17:10:05 +00:00
Guillaume Lours b897915663
release-notes for Compose v2.29.7 and v2.30.0 versions (#21273)
<!--Delete sections as needed -->

## Description
Added release notes for Compose `v2.29.7` and `v2.30.0` releases

## Related issues or tickets
https://docker.atlassian.net/browse/COMP-813
<!-- 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

Signed-off-by: Guillaume Lours <705411+glours@users.noreply.github.com>
2024-10-29 17:09:42 +00:00
Arie Heinrich c17faccf17
Spelling fixes (#21230)
Christmas is early :) and i had some free time to go over all the
documents and fix all spelling mistakes i have found.
2024-10-24 13:02:40 +02:00
Allie Sadler e328d00b20
ENDOCS-2254 (#21205)
* ENDOCS-2254

* formatting
2024-10-23 09:22:45 +01:00
Okpara Ifeanyi d2c3f0194f
include backend service (#21162)
include backend service when docker compose --profile debug up is executed
2024-10-21 09:47:14 +01:00
Dave Meyer 52df73bd3f
Update compose-application-model.md: Added period (#21160)
Added missing period to end of sentence.
2024-10-21 09:46:15 +01:00