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
[docs] Formatting and proper noun tune-up #4200
Conversation
Replace “DDEV-Local” + “DDEV-Live”, and lowercase “ddev” when it’s related to the product and not the command or binary. Curly quotes for possessive form, backticks for binary or command references.
Download the artifacts for this pull request: |
Proper nouns, heading style, abolition of “just”, smart quotes, links, and edits for brevity and clarity.
Smart quotes, backticks, heading and list formatting, edits for brevity and clarity.
Backticks, smart quotes, list formatting, capitalization, minor edits for clarity.
Took a wild stab at editing for clarity.
Plus some bonus spaces around arrows (`→`) because I had to.
Smart quotes, list+heading formatting, backticks, “I” → “we”, misc. capitalization, various edits for brevity and clarity.
Title casing, smart quotes, minor edits for brevity and clarity, active speaker, more consistent use of `!!!tip` and `!!!warning` instead of callouts.
DDEV already clear from context, and `&` shortens navigation + page title for better readability.
Worked through
The heading changed so it was correct to call it out at first. But it should be right now and it behaves fine in my browser. Just rambling to myself and will come back to it later. |
Co-authored-by: Randy Fay <randy@randyfay.com>
Co-authored-by: Randy Fay <randy@randyfay.com>
Co-authored-by: Matt Stein <m@ttste.in>
Attempted to preserve `exec-host` example in some form, and move (rather than delete) Drupal 8 Composer install step.
… into docs/consistency-improvement
… into docs/consistency-improvement
Previously removed because of visual redundancy, but they’re necessary for orderly sidebar navigation.
Remove `’` variants which ... don’t seem to be necessary now? Add two words.
Not sure how I managed to break the Buildkit tests @rfay, but otherwise ready to roll!
|
Restarted, but TestComposerVersion may in fact be broken, we'll see what happens. |
Looks like it's all going to pass, let me know when it's ready to pull! |
Tests finally finished, resubmitted for review! (Ready to pull.) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yay, thanks!
This PR is for tracking some of the initial cleanup work involved on #4188.
<kbd>
elements for representing literal keystrokes!!!note
,!!!tip
and!!!warning
callouts for asides, as opposed to Note: prefixes and other variationsEdits are tediously separated and described in smallish commits.