Fix login documentation layout#1414
Fix login documentation layout#1414thaJeztah merged 1 commit intodocker:masterfrom Deepomatic:1413-fix-login-documentation-layout
Conversation
thaJeztah
left a comment
thaJeztah
left a comment
There was a problem hiding this comment.
thank you! I left some thoughts; happy to discuss 🤗
docs/reference/commandline/login.md
Outdated
| - Microsoft Windows Credential Manager: https://github.com/docker/docker-credential-helpers/releases | ||
| - [pass](https://www.passwordstore.org/): https://github.com/docker/docker-credential-helpers/releases | ||
|
|
||
| #### Usage |
There was a problem hiding this comment.
Thinking if we should use a more descriptive title; perhaps "Credentials store configuration", or "Configure the credentials store" ?
(open to suggestions 😅)
There was a problem hiding this comment.
I went for the Configure the ... way. Both ways already existed:
run.md:787:### Configure namespaced kernel parameters (sysctls) at runtime
pull.md:40:### Proxy configuration
docs/reference/commandline/login.md
Outdated
| operations concerning credentials of the specified registries. | ||
|
|
||
| ### Logging out | ||
| #### Usage |
There was a problem hiding this comment.
Thinking if we should use a more descriptive title; perhaps "Credential helper configuration", or "Configure credential helpers" ?
| credential store (`credsStore` or the config file itself) will not be used for | ||
| operations concerning credentials of the specified registries. | ||
|
|
||
| ### Logging out |
There was a problem hiding this comment.
Good catch; would be worth to add a "Related commands" at the end of this file, to link to logout (similar to https://github.com/docker/cli/blob/master/docs/reference/commandline/plugin_create.md#related-commands)
| #### Usage | ||
|
|
||
| If you are currently logged in, run `docker logout` to remove | ||
| the credentials from the default store. |
There was a problem hiding this comment.
If you're interested in making some additional changes (could be in a follow-up); I think we should include a link somewhere to the section describing where the cli configuration file is; https://github.com/docker/cli/blob/master/docs/reference/commandline/cli.md#configuration-files)
There was a problem hiding this comment.
I'll probably do that in a follow-up PR soon.
ddadd3d mass standardized the formatting, with some errors. This commit fixes errors on `login.md`: - revert wrong `Logging out` headline - restore correct level for some headlines (relative to parent headline level change) - re-add `Usage` headlines, with better name Also add `related commands` headline on `login` and `logout`. Signed-off-by: Thomas Riccardi <thomas@deepomatic.com>
Codecov Report
@@ Coverage Diff @@
## master #1414 +/- ##
=======================================
Coverage 54.26% 54.26%
=======================================
Files 289 289
Lines 19331 19331
=======================================
Hits 10490 10490
Misses 8165 8165
Partials 676 676 |
5 participants
closes #1413
- What I did
ddadd3d mass standardized the
formatting, with some errors.
This commit fixes errors on
login.mdLogging outheadlineheadline level change)
- How I did it
.
- How to verify it
Check rendered documentation
- Description for the changelog
Better
logindocumentation layout