Clean up and format markdown documentation #2714
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs/deployment.md
Outdated
| puma, described separately in our [restart documentation](restart.md). | ||
| Puma to start running that new code. There are a few options for restarting | ||
| Puma, described separately in our [restart documentation](restart.md). | ||
| # Deployment engineering for Puma |
|
Looks good except for the one possible copy paste error I found. One thing I've always thought about re: our docs was could we make them easier for ESL speakers to understand - decrease reading level, simplify vocabulary, etc. Thought for the future. |
jacobherrington
force-pushed
the
jacobherrington/doc-cleanup
branch
from
e85b93f
to
6311e97
Compare
|
@nateberkopec Thanks for the review. I addressed your comments and pushed new commits. I agree with the goal of simplifying the language, especially for people who aren't native English speakers or aren't familiar with idioms that might be present in the docs. 馃憤 |
JuanitoFatas
pushed a commit
to JuanitoFatas/puma
that referenced
this pull request
Sep 9, 2022
* Revise and format architecture docs [ci skip] * Fix typo and format compile options doc [ci skip] * Revise and format deployment doc [ci skip] * Revise and format plugins doc [ci skip] * Fix mechanical typos [ci skip] * Revise restart.md [ci skip] * Revise signals.md [ci skip] * Revise stats.md [ci skip] * Revise and format systemd.md [ci skip]
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
I am reading through most of Puma's documentation, so I decided to make some minor improvements!
Generally, I am trying to reduce wordiness, improve clarity, and fix mechanical mistakes.
Additionally, in this PR I used my text editor to reformat some of the files. It generates a lot of git noise, so I only did that on files that seemed to be word-wrapped at one time in the past. I think this is useful for a couple of reasons, 1) it makes the git history of these files much more useful and clear going forward (changing a comma doesn't result in a diff that touches an entire paragraph this way), 2) some people do prefer to read these files in tmux panes or tiled text editors and I don't mind hitting a hotkey to accommodate them :).
If these changes are too broad or not deemed useful enough, I can always undo the formatting step.
Your checklist for this pull request
[ci skip]to the title of the PR.#issue" to the PR description or my commit messages.