#923 - Docker man pages need some love #5056
Open
+208
−208
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.
…exas.edu> Signed-off by: Pranjal Rai [email protected]
- 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
- A picture of a cute animal (not mandatory but encouraged)