Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#923 - Docker man pages need some love #5056

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pranjalrai4
Copy link

@pranjalrai4 pranjalrai4 commented May 4, 2024

…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

…exas.edu> Signed-off by: Pranjal Rai <pranjalrai@utexas.edu>
@pranjalrai4 pranjalrai4 changed the title Grace Choi and Pranjal Rai: Solving Issue #923 docker man pages need some love #923 - docker man pages need some love May 4, 2024
@pranjalrai4 pranjalrai4 changed the title #923 - docker man pages need some love #923 - Docker man pages need some love May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant