Commit Graph

20 Commits

Author SHA1 Message Date
David Karlsson
cbceafed09 docs: address issue #24163 (#24177)
## Summary
Removed repeated text about path behavior in the Compose Build
Specification documentation.

## Changes
- Consolidated duplicate sentences about absolute/relative path behavior
that appeared in both the "former case" and "latter case" paragraphs
- Improved clarity by explicitly referencing "When `build` is specified
as a string" and "When `build` is specified as a detailed structure"
instead of vague "former/latter" references
- Added a single consolidated paragraph explaining path behavior that
applies to both cases

Fixes #24163

---
🤖 Generated with [cagent](https://github.com/docker/cagent)
2026-02-27 13:22:53 +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
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
Allie Sadler
49771bafee ENGDOCS-2944 (#23311)
<!--Delete sections as needed -->

## Description

Fixes https://github.com/docker/docs/issues/23160
Fixes https://github.com/docker/docs/issues/23051

## 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-08-26 16:06:49 +01:00
Allie Sadler
078cf597c0 minor spec updates (#23213) 2025-08-08 08:17:09 +01:00
Allie Sadler
83d589d2de build attributes (#23149)
<!--Delete sections as needed -->

## Description

https://github.com/docker/docs/pull/23148/files

## 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-24 13:27:56 +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
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
Etienne Guerlain
1278c5b4c8 Update example in the Compose Build Specification (additional_contexts) to ease it's understanding (#22140)
There might by a slight error when illustrating the
`additional_contexts` attribute. The compose file declares two services
with the same name. It might induce misunderstanding, especially since
the second service's image uses the first one to build upon.

## Description

I replaced the key defining the second service of the compose file used
to illustrate the `additional_contexts` attribute, since the key `base`
is used twice. Of course, any better replacement could be used, instead
of `my-service`.

It is invalid to use the same key twice (the error: `mapping key "base"
already defined at line 2` is expected on `docker compose up`), and it
does harm the understanding of the illustrated point of building a
service's image using another one to share layers.

## Reviews

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

- [ ] Technical review
- [ ] Editorial review
- [ ] Product review
2025-03-03 09:46:09 +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
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
Allie Sadler
21839d5b86 ENGDOCS-2276 (#21245)
<!--Delete sections as needed -->

## Description

To match https://github.com/compose-spec/compose-spec/pull/540

## 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-25 15:27:43 +01:00
Allie Sadler
9d975a92a6 ENGDOCS-2228 (#20940)
* ENGDOCS-2228

* fix build

* title edits
2024-09-19 16:22:09 +01:00
Allie Sadler
4021d76e8b compose spec consistency (#20915)
* compose spec consistency

* fix links

* Update content/reference/compose-file/build.md

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

---------

Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-09-16 14:57:42 +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
f99be0f9df compose: fix link to RUN --mount=type=ssh
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
2024-08-19 17:04:28 +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