Skip to content
GitLab Next
  • Menu
Projects Groups Snippets
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • T Technical Writing
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 92
    • Issues 92
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
  • Merge requests 1
    • Merge requests 1
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Releases
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Wiki
    • Wiki
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.org
  • Technical Writing
  • Issues
  • #352
Closed
Open
Created Jan 08, 2021 by Susan Tacker@susantacker💡Maintainer

Key Result: Review and revise UI text on Project Settings pages => 45/54, 83%

Part of the FY22-Q1 UX Department OKRs.

The UI text on GitLab Settings pages needs to be reviewed and edited for wordiness, passive voice, inconsistency, and future tense. Are the field descriptions clear? You may discover other issues to fix as well.

First, we will use the Pajamas UI text guidance voice and tone requirements. Familiarize yourself with the guidelines in the entire "Content" section of Pajamas.

We will not change field names or button names unless they're egregious, because we'd also have to then go fix the doc.

Current tally (as of May 1): 45 completed issues out of 54 (83% of total)

Target: 38/54 (70%)

Background

  • Every Technical Writer will review UI text for the Settings sections for Integrations, Webhooks, Access Tokens, Operations, Pages, and Audit Events within the Project Settings of the GitLab application.
  • After completing their review, Technical Writers will make relevant updates to their assigned sections' wording within the code.
  • Issues have already been created for each section that needs a review.

OKR Process

  • TWs should self-assign x issues throughout the quarter; not all at once, but one open issue at a time.
  • Use the UI-text template in the Technical Writing project.
  • Assign yourself to the issue created for the section you're working on, and add your name to the following table for that section.

Settings section list

Settings Section Issue Technical Writer
General Visibility, project features, permissions #309 (closed) @rdickenson
General Merge requests #310 (closed) @msedlakjakubowski
CI/CD Deploy freezes #323 (closed) @marcia
Repository Push Rules #326 (closed) @marcia
Repository Deploy Tokens #330 (closed) @mjang1
Repository Deploy Keys #331 (closed) @marcia
Integrations Top-level page gitlab#300564 (closed) @axil
Integrations Alerts endpoint gitlab#300565 (closed) @mjang1 -- duplicate of gitlab#300629 (closed)
Integrations Asana gitlab#300567 (closed) @msedlakjakubowski
Integrations Assembla gitlab#300584 (closed) @ngaskill
Integrations Atlassian Bamboo CI gitlab#300585 (closed) @marcel.amirault
Integrations Bugzilla gitlab#300586 (closed) @rdickenson
Integrations Buildkite gitlab#300587 (closed)
Integrations Campfire gitlab#300588 (closed)
Integrations Confluence Workspace gitlab#300589 (closed) @marcel.amirault
Integrations Custom Issue Tracker gitlab#300590 (closed) @msedlakjakubowski
Integrations Discord Notifications gitlab#300591 (closed) @marcel.amirault
Integrations Drone CI gitlab#300592 (closed) @marcel.amirault
Integrations EWM gitlab#300593 (closed) @msedlakjakubowski
Integrations Emails on push gitlab#300594 (closed) @mjang1
Integrations External Wiki gitlab#300596 (closed) @marcia
Integrations Flowdock gitlab#300597 (closed) @marcia
Integrations GitHub gitlab#300598 (closed) @msedlakjakubowski
Integrations Hangouts Chat gitlab#300599 (closed) @marcia
Integrations HipChat gitlab#300600 (closed) @marcel.amirault
Integrations Irker (IRC gateway) gitlab#300601 (closed)
Integrations Jenkins CI gitlab#300605 (closed) @marcel.amirault
Integrations JetBrains TeamCity CI gitlab#300607 (closed) @marcel.amirault
Integrations Jira gitlab#300608 (closed) @rdickenson
Integrations Mattermost notifications gitlab#300609 (closed) @marcel.amirault
Integrations Mattermost slash commands gitlab#300610 (closed) @aqualls
Integrations Microsoft Teams Notification gitlab#300611 (closed) @aqualls
Integrations Packagist gitlab#300612 (closed)
Integrations Pipelines emails gitlab#300614 (closed) @marcel.amirault
Integrations PivotalTracker gitlab#300616 (closed)
Integrations Prometheus gitlab#300617 (closed) @aqualls
Integrations Pushover gitlab#300618 (closed)
Integrations Redmine gitlab#300620 (closed) @msedlakjakubowski
Integrations Slack application gitlab#300621 (closed)
Integrations Slack notifications gitlab#300622 (closed) @marcel.amirault
Integrations Unify Circuit gitlab#300623 (closed)
Integrations Webex Teams gitlab#300625 (closed) @eread
Integrations YouTrack gitlab#300626 (closed) @msedlakjakubowski
Webhooks Top-level page gitlab#300627 (closed) @eread
Access Tokens Top-level page gitlab#300628 (closed) @axil
Operations Alerts gitlab#300629 (closed) @mjang1
Operations Incidents gitlab#300631 (closed) @ngaskill
Operations Error tracking gitlab#300632 (closed) @ngaskill
Operations Metrics dashboard gitlab#300633 (closed) @mjang1
Operations Grafana authentication gitlab#300634 (closed) @eread
Operations Jaeger tracing gitlab#300636 (closed) @eread
Operations Status page gitlab#300637 (closed) @ngaskill
Pages Top-level page gitlab#300638 (closed) @axil
Audit Events Top-level page gitlab#300639 (closed) @axil

Links and references

We are tackling a subset of all GitLab Settings pages. The complete list is here:

  • Settings audit: https://docs.google.com/spreadsheets/d/1gZ2vyfEB_IQyaUMeOwtM6u2tD0JNXTcpJuNPoUHK-Es/edit?usp=sharing
Edited May 03, 2021 by Craig Norris
Assignee
Assign to
Time tracking