Source repo for Docker's Documentation
Go to file
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
.docker use custom Dockerfile for Dev Environments image 2021-06-24 16:42:51 +02:00
.github Draft 2023-03-20 13:22:18 +01:00
_data Merge pull request #16919 from ChrisChinchilla/chrisward/dsosp-docs 2023-03-21 10:32:08 +01:00
_deploy/nginx NGINX config: add redirect rules for obsolete archive pages 2020-02-28 15:10:24 +01:00
_includes Small polish for freshness updates 2023-03-14 13:01:24 +01:00
_layouts adjust title of homepage (#16708) 2023-02-15 11:27:49 +00:00
_plugins Merge pull request #16151 from crazy-max/last-date-fallback 2022-11-14 14:06:34 +01:00
_releaser build(deps): bump golang.org/x/net from 0.1.0 to 0.7.0 in /_releaser 2023-02-18 03:17:23 +00:00
_scss fix code overlapping toc (#16843) 2023-03-07 16:16:59 +00:00
assets do not append anchorLink for tiles 2023-03-17 16:41:46 +01:00
billing ENGDOCS-1258 (#16857) 2023-03-14 08:58:53 +00:00
build build: change sections order in toc 2023-03-17 14:22:03 +01:00
cloud Engdocs 802b (#15108) 2022-07-13 10:41:56 +01:00
compose Add detailed project name requirements, mechanisms (#16915) 2023-03-22 08:59:55 +00:00
config Merge pull request #16921 from ChrisChinchilla/chrisward/daemon-change 2023-03-20 18:10:47 +01:00
contribute Fix several missing periods 2023-03-15 18:49:09 +00:00
desktop Desktop 4.17.1 release notes (#16905) 2023-03-20 13:56:57 +00:00
develop Fix a broken link 2023-03-21 19:04:10 +00:00
docker-hub Merge pull request #16919 from ChrisChinchilla/chrisward/dsosp-docs 2023-03-21 10:32:08 +01:00
docker-id updated note 2022-11-07 16:38:25 -06:00
engine Small polish for freshness updates 2023-03-14 13:01:24 +01:00
get-started Update get started part 7 (#16821) 2023-03-06 07:44:33 -08:00
language Merge pull request #16878 from ChrisChinchilla/chrisward/python-build 2023-03-14 13:09:19 +01:00
network Improve alt text on images (#16484) 2023-01-10 16:28:46 +00:00
reference reference: remove docs for deprecated "docker app" 2023-02-01 20:24:58 +01:00
registry update registry example (#16578) 2023-01-23 13:34:10 +00:00
release-notes engine: add 23.0 release notes 2023-02-02 15:20:17 +01:00
samples add redirect 2022-11-22 11:06:24 -08:00
scout Update scout/index.md 2023-03-13 10:43:52 +01:00
security scout: add docs for docker scout hub and cli 2023-02-24 15:25:56 +01:00
single-sign-on Solve merge conflict for etc. fix (#16827) 2023-03-15 10:07:30 +00:00
storage keywords (#16691) 2023-02-08 14:42:21 +00:00
subscription Engdocs 1260 (#16888) 2023-03-16 12:08:12 +00:00
support fixed links 2022-10-26 11:01:58 -05:00
.dockerignore jekyll: fix sitemap lastmod 2022-10-25 06:25:49 +02:00
.editorconfig Add .editorconfig 2021-07-12 09:07:16 +01:00
.env compose file: enable buildkit for building 2020-02-24 13:56:16 +01:00
.gitattributes Add .gitattributes file for default line endings 2021-05-26 14:59:03 +01:00
.gitignore ci: add annotations for mdl and htmlproofer 2022-08-03 09:58:01 +01:00
.markdownlint.json Add linting information to CONTRIBUTING.md 2022-08-03 09:58:01 +01:00
.markdownlint.rb Add linting information to CONTRIBUTING.md 2022-08-03 09:58:01 +01:00
.nojekyll
.ruby-version Bump ruby from 2.6.10 to 2.7.6 2022-05-25 01:03:35 +02:00
.vale.ini Add information about new Domain data point (#15798) 2022-10-17 15:08:13 +00:00
404.md jekyll: add hotjar for prod environment (#15978) 2022-10-27 14:30:12 +02:00
CONTRIBUTING.md Fix link (#15567) 2022-09-05 14:27:12 +00:00
Dockerfile Dockerfile: remove htmlproofer workaround for buildx_build 2023-01-13 15:25:37 +01:00
Gemfile build(deps): bump git from 1.12.0 to 1.13.0 2023-01-09 22:04:44 +00:00
Gemfile.lock build(deps): bump git from 1.12.0 to 1.13.0 2023-01-09 22:04:44 +00:00
LICENSE
Makefile makefile: remove buildx-yaml goal 2022-08-16 12:53:30 +02:00
README.md Improve read me feedback details 2023-03-01 13:19:28 +01:00
_config.yml Previous commit updated wrong section 2023-03-06 15:18:12 +01:00
_config_production.yml jekyll: merge scopes and exclusions config 2022-11-06 00:47:46 +01:00
_config_stage.yml add hotjar for staging environment 2022-10-25 20:21:47 +02:00
_redirects.yml guide: remote dev with k8s and telepresence (#16813) 2023-03-01 08:46:08 +00:00
docker-bake.hcl jekyll(last_modified_at): fix for remote resources and data files (#15998) 2022-10-31 09:01:42 +01:00
docker-compose.yml compose-file: prevent pulling old docs/docstage image 2022-12-07 12:45:17 +01:00
docsarchive.md rename docs repository 2022-09-29 11:07:53 +02:00
get-docker.md keywords (#16691) 2023-02-08 14:42:21 +00:00
glossary.md jekyll: add hotjar for prod environment (#15978) 2022-10-27 14:30:12 +02:00
google161104f9fdea6089.html
googlecbe7fee896be512c.html
index.md adjust title of homepage (#16708) 2023-02-15 11:27:49 +00:00
release-lifecycle.md DD 4.15: Dev Velocity and POS content updates (#16176) 2022-12-01 15:26:08 +00:00
robots.txt remove most of absolute urls 2022-08-03 11:50:33 +02:00
search.md keywords (#16691) 2023-02-08 14:42:21 +00:00
sitemap.xsl jekyll: add simple sitemap xsl 2022-07-28 19:30:55 +02:00

README.md

Docs @ Docker

Welcome to Docker Documentation

Welcome to the Docker Documentation repository. This is the source for https://docs.docker.com/.

Feel free to send us pull requests and file issues. Our docs are completely open source and we deeply appreciate contributions from the Docker community!

Provide feedback

Wed love to hear your feedback. Please file documentation issues only in the docs GitHub repository. You can file a new issue to suggest improvements or if you see any errors in the existing documentation.

Before submitting a new issue, check whether the issue has already been reported. You can join the discussion using an emoji, or by adding a comment to an existing issue. If possible, we recommend that you suggest a fix to the issue by creating a pull request.

You can ask general questions and get community support through the Docker Community Slack. Personalized support is available through the Docker Pro, Team, and Business subscriptions. See Docker Pricing for details.

If you have an idea for a new feature or behavior change in a specific aspect of Docker, or have found a product bug, file that issue in the project's code repository.

We've made it really easy for you to file new issues.

  • Click New issue on the docs repository and fill in the details, or

  • Click Request docs changes in the right column of every page on docs.docker.com and add the details, or

    Request changes link

  • Click the Give feedback link on the side of every page in the docs.

    Docs feedback on each page

Contribute to Docker docs

We value your contribution. We'd like to make it as easy as possible to submit your contributions to the Docker docs repository. Changes to the docs are handled through pull requests against the master branch. To learn how to contribute, see our Contribute section.

Copyright 2013-2023 Docker, inc, released under the Apache 2.0 license.