Skip to content

OKR: Integrations/Asana - 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 > Asana**.

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:

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.

  1. 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.

  2. Review your changes in the GDK to ensure they're correct.

  3. Generate the .pot files by running:

    bin/rake gettext:regenerate
  4. Generate a changelog by running:

    bin/changelog -m "Updated UI text to match style guidelines"
  5. Open an MR that's linked to this issue, and then assign it to another writer for review/approval.

  6. Assign to the roulette-recommended engineer for merge.

Associated with technical-writing#352

Edited by Marcin Sedlak-Jakubowski