Skip to content

docs: update start docs to add examples - #4318

Open
craig-osterhout wants to merge 5 commits into
docker:masterfrom
craig-osterhout:update-start-docs
Open

docs: update start docs to add examples#4318
craig-osterhout wants to merge 5 commits into
docker:masterfrom
craig-osterhout:update-start-docs

Conversation

@craig-osterhout

Copy link
Copy Markdown
Contributor

- What I did
There are no examples in the documentation for the docker start options.
I created examples in the documentation for every option.

- How I did it
I created examples based on examples from related commands. Then, verified that they worked.
For 3 options, I was unable to verify the results. No CLI errors were given using the example syntax. I added them assuming it was not a CLI syntax issue.

  • For --checkpoint, when I run docker start, it just hangs. On Linux with experimental enabled and criu installed.
  • For --checkpoint-dir, it gives a message that it's not supported. Already a moby issue opened regarding this.
  • For --detach-keys, I was unable to get it to work on Windows or Linux.

- How to verify it
Run the examples.

- Description for the changelog
Updated start docs to add examples

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
@codecov-commenter

codecov-commenter commented May 30, 2023

Copy link
Copy Markdown

Codecov Report

Merging #4318 (22aff71) into master (5be2139) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@ Coverage Diff @@## master #4318 +/- ##
=======================================
Coverage 59.07% 59.07% =======================================
Files 287 287 Lines 24752 24752 =======================================
Hits 14623 14623 Misses 9249 9249 Partials 880 880 

Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md Outdated
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Comment threaddocs/reference/commandline/start.md Outdated
Comment on lines +58 to +61
The `--checkpoint` option is an experimental feature, and should not be
considered stable. To read about experimental daemon options and how to enable
them, see
[Daemon configuration file](https://docs.docker.com/engine/reference/commandline/dockerd/#daemon-configuration-file).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm.. I thought we had a /go/ redirect for this one, but looks like that's only for experimental CLI features (but those are now enabled by default). https://github.com/docker/docs/blob/8d81583dcf89cf302420ca5f5c8a39b22a7e73fb/_redirects.yml#L106-L107

Perhaps we should repurpose that redirect for both cli (no longer needed) and engine features (and have a canonical section about enabling experimental features, etc).

@dvdksn perhaps you have ideas on that?

Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md Outdated
Comment threaddocs/reference/commandline/start.md
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
@thaJeztahthaJeztah added this to the 29.5.1 milestone May 14, 2026
@vvolandvvoland modified the milestones: 29.5.1, 29.5.2May 18, 2026
@thaJeztahthaJeztah modified the milestones: 29.5.2, 29.5.3May 20, 2026
@vvolandvvoland modified the milestones: 29.5.3, 29.6.0Jun 3, 2026
@vvolandvvoland modified the milestones: 29.6.0, 29.6.1Jun 18, 2026
@vvolandvvoland modified the milestones: 29.6.1, 29.7.0Jun 30, 2026
@vvolandvvoland modified the milestones: 29.7.0, 29.8.0Jul 30, 2026
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@craig-osterhout@codecov-commenter@thaJeztah@vvoland