You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Use desired language in migration guide template (#18576)
# Objective
Both reading and writing migration guides is easier when the language is
standardized.
However, migration guide authors don't have clear guidelines for the
tone and phrasing to use.
## Solution
Communicate this information to authors by creating stub text with a
clear and polite standard style.
We could instead write a style guide, but turning style guides into a
writing style is slower and much harder than simply filling in the
blanks. While style guides are a good fit for more free-form writing,
they don't work well for the very mechanical and dry migration guides.
---------
Co-authored-by: Miles Silberling-Cook <[email protected]>
0 commit comments