Skip to content

OKR: CI/CD/General pipelines - 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 > CI/CD > General pipelines.

Remember: With UI text, less is more. If you need to go into detail, link to the docs

Update this section of the UI to meet the Pajamas style guidelines: Settings > CI/CD > General pipelines.

Review grammar and style

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. Note that 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 @marcel.amirault (the TW for CI) for review/approval.

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

Associated with technical-writing#278

Edited by Marcel Amirault