Commit Graph

14 Commits

Author SHA1 Message Date
Allie Sadler 0035868d2b
Engdocs 1428 (#17506)
* Desktop meta descriptions

* compose meta descriptions

* checks
2023-06-09 08:39:23 +01:00
Allie Sadler 15cd2b0972
Compose secrets (#17321)
* tidy

* editorial fixes
2023-05-17 11:04:23 +01:00
bagratte 517bd4b035
Proofread Compose Environment Variables (#17269) 2023-05-10 13:04:46 +01:00
Milas Bowman a62805e3eb
Compose v2 guide [ENGDOCS-1319] (#17209)
* initial content

* edits

* fix links

* compose: bunch of changes/additions around migration

* Apply suggestions from code review

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>

* review feedback & link fixes

* fix another link

* update TOC page title to match

* move redirect to migrate page

* update v1 eol blurb

* fix eol warning style

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2023-05-10 08:42:35 +01:00
Kibubu e06245ea95
Add info invalid references (#17224)
* Add info invalid references

The example shows a configuration that would raise a invalid image reference error if the environment variable for the image is set to an empty string or is not set at all.

Also the code format ticks included the period.

#17192

A warning was added to highlight the incorrect configuration and the ticks now exclude the period.

* Apply suggestions from code review

---------

Co-authored-by: Allie Sadler <102604716+aevesdocker@users.noreply.github.com>
2023-05-09 14:00:05 +01:00
Allie Sadler 8be114620e
ENGDOCS-1269 (#16936)
* ENGDOCS-1269

* feedback changes
2023-03-22 13:47:11 +00:00
Allie Sadler 855cda4011
Spec split (#16740)
* split spec

* spec split

* trial branch

* fix

* branch update

* landing page

* add description

* add description

* update file path

* tweak

* fix build

* split spec

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* spec split

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* trial branch

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* branch update

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* landing page

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* add description

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* update file path

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* tweak

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* fix build

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* missing new line

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>

* first batch of fix links

* second batch of link fix

* update toc

---------

Signed-off-by: CrazyMax <crazy-max@users.noreply.github.com>
Co-authored-by: CrazyMax <crazy-max@users.noreply.github.com>
2023-03-22 12:00:04 +00:00
Mike Bland e04f063645
Add detailed project name requirements, mechanisms (#16915)
* Add detailed project name requirements, mechanisms

These changes reflect updated `docker compose` behavior regarding
acceptable project names.

compose-spec/compose-go#261 changed `docker compose` behavior to require
normalized project names as input when using `-p`. Previously `docker
compose` normalized project names automatically, leading to errors for
some users after the change landed in compose-spec/compose-go v1.2.5 and
docker/compose v2.5.1.

compose-spec/compose-spec#314 updated the compose spec, effectively
enforcing the same constraint for the `name:` config file property.
compose-spec/compose-go#362 added information to the error message
specifying the correct project name format. compose-spec/compose-go#364
added enforcement of the new project name requirements for all project
name mechanisms (`-p`, `name:`, `COMPOSE_PROJECT_NAME`, project dir,
working dir).

Local development URLs:
- http://localhost:4000/compose/reference/#use--p-to-specify-a-project-name
- http://localhost:4000/compose/environment-variables/envvars/#compose_project_name
- http://localhost:4000/engine/reference/commandline/compose/#use--p-to-specify-a-project-name

Production URLs:
- https://docs.docker.com/compose/reference/#use--p-to-specify-a-project-name
- https://docs.docker.com/compose/environment-variables/envvars/#compose_project_name
- https://docs.docker.com/engine/reference/commandline/compose/#use--p-to-specify-a-project-name

Signed-off-by: Mike Bland <mbland@acm.org>

* Revert _data/compose-cli/docker_compose.yaml

This reverts part of commit 9ce29a8aec.

As @glours noted in the review of #16915, this content comes from the
upstream docker/compose repo. He's opened docker/compose#10390 to apply
the update there instead.

Signed-off-by: Mike Bland <mbland@acm.org>

---------

Signed-off-by: Mike Bland <mbland@acm.org>
2023-03-22 08:59:55 +00:00
Allie Sadler 3d563746f5
replace convert with config (#16925) 2023-03-21 11:01:06 +00:00
Allie Sadler 9762aecc41
housekeeping (#16754)
* housekeeping

* fix envvars-precedence
2023-02-21 12:25:43 +00:00
Guillaume Lours 3923985d51
Update Compose reference API to v2.16.0 (#16702)
Signed-off-by: GitHub <noreply@github.com>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Co-authored-by: glours <glours@users.noreply.github.com>
2023-02-10 09:14:54 +00:00
Jens Erat e0a45ff946
fix typo in env-file argument (#16698) 2023-02-09 12:45:58 +00:00
Allie Sadler d165097c0d
ENGDOCS-1166a (#16641) 2023-01-31 15:27:52 +00:00
Allie Sadler 3a09816b5c
Engdocs 1067a (#16628)
* updated toc

* move env-file.md

* update env-file.md content

* move envvars-precedence.md

* change envvars-precedence content

* move envvars.md

* change content of envvars.md

* move and rename environment-variables.md

* change content for set-environment-variables.md

* fix links

* format fix
2023-01-30 11:27:59 +00:00