OKR: Integrations/GitHub - Review and revise settings-related UI text
Update UI text to meet our style guidelines
Update this section of the UI to meet the Pajamas style guidelines: Settings > Integrations > GitHub.
Remember: With UI text, less is more. If you need to go into detail, link to the docs.
Top-level Integration page update relating to this issue
The changes to this setting should also include revising the description for this integration as displayed on the top-level Integrations Settings UI page. The issue for that top-level page contains a link to a spreadsheet that contains proposed new text for this integrations description on that page.
If you need to modify or create a description for the integration (perhaps it's incorrect or not there), be sure to add the new description to the sheet in the form of "Verb action.", similar to the other examples, and then incorporate that wording into your changes in the application.
After the description update on the top-level Integrations page, be sure to add a question svg (described in Pajamas that links to the URL in the sheet for the integration doc page. If the page isn't listed, you'll need to go find it. Be sure to also add an aria link to the link you add to the description for the integration doc page (described in Pajamas, at the end of the linked page).
Grammar and style review checklist
At a minimum, address these issues:
-
Present tense rather than future. https://design.gitlab.com/content/voice-tone#instructions -
Active voice. https://design.gitlab.com/content/voice-tone#active-voice -
No periods for settings or headings. https://design.gitlab.com/content/punctuation#periods -
Periods for all help text. -
No repetitive or unnecessary text. (Things like: This setting is... or "Use this setting to.") -
Oxford comma used correctly. (This, this, and this.) -
Language is parallel. (Review all the settings in the section to ensure they are similarly-worded.) https://design.gitlab.com/content/voice-tone#parallelism -
If a setting is optional, then "optional" is in parentheses at the end of the setting name. https://design.gitlab.com/components/form/#required-information -
Latinisms (i.e., e.g.) removed. https://design.gitlab.com/content/voice-tone#avoid-latin-abbreviations -
Don't use "allow" unless you're specifically talking about security. For example, "Allows users to fork the repo" should be "Users can fork the repo." -
If you have a link to documentation, attempt to refer to the link as a question (like, "How do I configure runners?"). If not possible, use "Learn more." https://design.gitlab.com/usability/helping-users#formatting-help-content -
Update the description on the top-level Integration page for this integration, based on the comments in the previous section of the issue description. -
Utilize the placeholder
andhelp
attributes for elements correctly. For example, if existing help text is entirely in theplaceholder
attribute, and needed info isn't inhelp
for the element, do what's needed to get relevant information intohelp
. More info. -
Do a final review of everything you've updated and consider whether it affects the docs. If it does, open a follow-up issue or an MR to update the docs.
Do not change the text for settings themselves. If you do feel strongly that a setting name should be changed, open a follow-up issue and work with a PM to change it. When you change a setting, the related docs also need to change. These changes are outside the scope of this issue.
How to update the text
After you've reviewed the text, you'll need to implement any changes or improvements in the GitLab application.
-
Search the code for the section name to find the UI text to be modified. You may need to modify more than one file to complete your text update work for the section. For example, seeing
render_if_exists
for an item in the section would have you also go to that file for potential additional changes to the section. -
Review your changes in the GDK to ensure they're correct.
-
Generate the
.pot
files by running:bin/rake gettext:regenerate
-
Generate a changelog by running:
bin/changelog -m "Updated UI text to match style guidelines"
-
Open an MR that's linked to this issue, and then assign it to another writer for review/approval.
-
Assign to the roulette-recommended engineer for merge.
Associated with technical-writing#352 (closed)