#923 - Docker man pages need some love

pranjalrai4 commented 2 months ago

…exas.edu> Signed-off by: Pranjal Rai pranjalrai@utexas.edu

- What I did

We changed the three man pages files which included docker-build.1.md, docker-config-json.5.md, and docker-run.1.md. We changed much of the styling based on the guidelines posted on the issue (issue #923) and the accompanying man pages guide. This guide was attached to the issue. We changed much of the phrasing, some bolding, italics, bullet points, naming conventions, spacing, and grammar.

- How I did it

We went through each of the requirements posted on the issue page and went through them one by one and changed the man page files accordingly.

- How to verify it You can look at the three files we changed (docker-build.1.md, docker-config-json.5.md, and docker-run.1.md) and either look at the commit history to see how these files have changed or you can run each of these files through a diff checker and compare how the file has changed from the original master copy.

- Description for the changelog

Formatting, semantic, and wording changes were made to the man pages.

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

thaJeztah commented 1 week ago

Thank you for contributing! It appears your commit message is missing a DCO sign-off, causing the DCO check to fail.

We require all commit messages to have a Signed-off-by line with your name and e-mail (see "Sign your work" in the CONTRIBUTING.md in this repository), which looks something like:

Signed-off-by: YourFirsName YourLastName <yourname@example.org>

There is no need to open a new pull request, but to fix this (and make CI pass), you need to amend the commit(s) in this pull request, and "force push" the amended commit.

Unfortunately, it's not possible to do so through GitHub's web UI, so this needs to be done through the git commandline.

You can find some instructions in the output of the DCO check (which can be found in the "checks" tab on this pull request), as well as in the Moby contributing guide.

Steps to do so "roughly" come down to:

Set your name and e-mail in git's configuration:
```
git config --global user.name "YourFirstName YourLastName"
git config --global user.email "yourname@example.org"
```
(Make sure to use your real name (not your GitHub username/handle) and e-mail)
Clone your fork locally
Check out the branch associated with this pull request
Sign-off and amend the existing commit(s)
```
git commit --amend --no-edit --signoff
```
If your pull request contains multiple commits, either squash the commits (if needed) or sign-off each individual commit.
Force push your branch to GitHub (using the --force or --force-with-lease flags) to update the pull request.

Sorry for the hassle (I wish GitHub would make this a bit easier to do), and let me know if you need help or more detailed instructions!

thaJeztah commented 1 week ago

Oh! Actually, I see what happened; it looks like your DCO sign-off is not on a separate line; there must be a empty line between the commit title and the sign-off, and currently they're on a single line;

issue 923 for docker manpages Signed-off-by: Grace Choi <gracechoi@utexas.edu> Signed-off by: Pranjal Rai <pranjalrai@utexas.edu>

docker / cli

#923 - Docker man pages need some love #5056