docs: update start docs to add examples#4318
Open
craig-osterhout wants to merge 5 commits into
Open
Conversation
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Codecov Report
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 |
thaJeztah
reviewed
Jun 2, 2023
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
thaJeztah
reviewed
Jun 7, 2023
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). |
Member
There was a problem hiding this comment.
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>
thaJeztah
reviewed
Jun 8, 2023
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
Signed-off-by: Craig Osterhout <craig.osterhout@docker.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
- What I did
There are no examples in the documentation for the
docker startoptions.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.
--checkpoint, when I run docker start, it just hangs. On Linux with experimental enabled and criu installed.--checkpoint-dir, it gives a message that it's not supported. Already a moby issue opened regarding this.--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