docs: editorial improvements, typo fixes by dvdksn · Pull Request #4712 · docker/cli

dvdksn · 2023-12-13T14:17:31Z

Signed-off-by: David Karlsson 35727626+dvdksn@users.noreply.github.com

q4 freshness updates

carries followups:

- What I did

- How I did it

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

dvdksn · 2023-12-13T15:07:33Z

@thaJeztah let me see if I can carry a couple follow-ups from the previous refresh as well

thaJeztah

overall looking good; left some comments/suggestions, and recalled some "related" changes that were never finished.

thaJeztah · 2023-12-13T15:11:12Z

+> TLS version 1.0 and higher is supported. Protocols SSLv3 and below are not
+> supported for security reasons.


Remind me; we need to verify what TLS versions we support now (it's very likely we no longer support 1.0)

thaJeztah · 2023-12-13T15:14:19Z

 ```

-### Allow push of nondistributable artifacts
+### Allow push of non-distributable artifacts


Remind me; we need to check the status on this one. I know the "foreign layers" feature was deprecated by the OCI, and we may be enabling this by default now (or are planning to)

thaJeztah · 2023-12-13T15:24:54Z

+- config (`config=<name or id>`)
+- container (`container=<name or id>`)
+- daemon (`daemon=<name or id>`)
+- event (`event=<event action>`)
+- image (`image=<repository or tag>`)
+- label (`label=<key>` or `label=<key>=<value>`)


Reminds me I had a PR to rewrite this to use tables, but some of the combinations in my examples were wrong, as combining some did not produce the same as --type 🤔 (IIRC); perhaps you're interested in carrying that PR though;
docs: docker events: use tables to describe filters #3263

Let me carry this one, but I'll do it in a follow-up as not to block this one since there's an open technical question

thaJeztah · 2023-12-13T15:28:44Z

We need to merge the events and system_events pages. Currently information is spread between them (and they may be out of sync).
I recall doing that as part of my "WIP use canonical URLs" but that got bit-rot.

dvdksn · 2023-12-18T13:48:13Z

@thaJeztah I pushed an additional update as a fixup (to make it easier to review), see
2b252a8

thaJeztah

overall LGTM (thanks!)

found a couple of minor issues, and one or two that may need checking (sudo and env-var, and perhaps update that redirected URL)

thaJeztah · 2023-12-19T15:27:50Z

-`tar` UNIX format and can be compressed with any one of the 'xz', 'bzip2',
-'gzip' or 'identity' (no compression) formats.
+`tar` Unix format and can be compressed with any one of the `xz`, `bzip2`,
+`gzip` or `identity` (no compression) formats.


I think zstd may now also work, but we'd have to check if it does (so no need to change for this PR)

thaJeztah · 2023-12-19T15:28:51Z


 This will build an image for a compressed context read from `STDIN`. Supported
-formats are: bzip2, gzip and xz.
+formats are: `bzip2`, `gzip` and `xz`.


Same here (also for follow-ups)

thaJeztah · 2023-12-19T15:38:17Z

 $ export DOCKER_TMPDIR=/mnt/disk2/tmp
-$ /usr/local/bin/dockerd --data-root /var/lib/docker -H unix:// > /var/lib/docker-machine/docker.log 2>&1
+$ sudo dockerd --data-root /var/lib/docker -H unix:// > /var/lib/docker-machine/docker.log 2>&1


Oh; does this work? sudo may be omitting the DOCKER_TMPDIR env-var (either requires sudo -E, or we should inline the env-var instead of exporting.
Also wondering if we should leave the > /var/lib/docker-machine/docker.log 2>&1 as an exercise to the reader (managing detached processes can be fiddly)

I don't even know what the redirect is doing in this case so I am happy to drop it

changed to sudo -Ehttps://github.com/docker/cli/pull/4712/files#diff-ed83365e097034def8fa52be7b46aa03b548344318bb62322dc777b311de2cb1L872-R867

codecov-commenter · 2023-12-19T16:14:28Z

Codecov Report

Merging #4712 (2b252a8) into master (103840e) will decrease coverage by 0.03%.
Report is 21 commits behind head on master.
The diff coverage is n/a.

❗ Current head 2b252a8 differs from pull request most recent head 6fd4cff. Consider uploading reports for the commit 6fd4cff to get more accurate results

Additional details and impacted files

@@ Coverage Diff @@## master #4712 +/- ##
==========================================
- Coverage 59.68% 59.65% -0.03% 
==========================================
Files 287 285 -2 Lines 24865 24757 -108 ==========================================
- Hits 14841 14770 -71 + Misses 9138 9100 -38 - Partials 886 887 +1

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

thaJeztah

LGTM

dvdksn requested a review from thaJeztah as a code owner December 13, 2023 14:17

thaJeztah added kind/docs status/3-docs-review labels Dec 13, 2023

thaJeztah assigned dvdksn Dec 13, 2023

dvdksn marked this pull request as draft December 13, 2023 15:07

dvdksn removed the status/3-docs-review label Dec 13, 2023

thaJeztah reviewed Dec 13, 2023
View reviewed changes

thaJeztah added the status/3-docs-review label Dec 13, 2023

dvdksn mentioned this pull request Dec 13, 2023
docs: refactor cli run reference #4615
Merged

dvdksn force-pushed the docs-tier1-fresshness-q4 branch from ae456a8 to 08f3affCompare December 13, 2023 16:57

dvdksn requested a review from thaJeztah December 13, 2023 16:57

dvdksn marked this pull request as ready for review December 13, 2023 19:00

dvdksn changed the title ~~docs: minor editorial improvements, typo fixes~~docs: editorial improvements, typo fixesDec 13, 2023

thaJeztah mentioned this pull request Dec 14, 2023
docs: fix typos and update formatting #4715
Merged

thaJeztah reviewed Dec 19, 2023
View reviewed changes

dvdksn force-pushed the docs-tier1-fresshness-q4 branch from 2b252a8 to db7c7ecCompare December 19, 2023 16:14

docs: minor editorial improvements, typo fixes
6fd4cff
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>

dvdksn force-pushed the docs-tier1-fresshness-q4 branch from db7c7ec to 6fd4cffCompare December 19, 2023 16:15

thaJeztah added this to the 25.0.0 milestone Dec 19, 2023

thaJeztah approved these changes Dec 19, 2023
View reviewed changes

thaJeztah merged commit 5ba998d into docker:masterDec 19, 2023

dvdksn deleted the docs-tier1-fresshness-q4 branch December 19, 2023 18:42

thaJeztah mentioned this pull request May 14, 2026
Fix typo #3247
Closed

		> TLS version 1.0 and higher is supported. Protocols SSLv3 and below are not
		> supported for security reasons.

Uh oh!

Conversation

dvdksn commented Dec 13, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dvdksn commented Dec 13, 2023

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dvdksn commented Dec 18, 2023

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov-commenter commented Dec 19, 2023• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

thaJeztah left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

dvdksn commented Dec 13, 2023•
edited
Loading

codecov-commenter commented Dec 19, 2023•
edited
Loading