Skip to content

Create Guardian UI terminology 'dictionary' #2835

@anvabr

Description

@anvabr

Problem description

There've been numerous occasions where Guardian UI displayed misspelled words/terms etc. Guardian product team always makes effort to ensure accuracy of the terminology used in the UI and system in general (including the codebase), however owing to the size of the project it has proved to be challenging without some automated tool to assist with this.

Requirements

  • Refactor Guardian UI to as much as possible 'externalise' words/phrases/text into a separate file or module which we can then automatically run through a syntax checker.
  • Design this in such a way that it would be possible in the future to introduce 'language' choice feature and display translated text from this file/module in the UI. (note: the actual implementation of this functionality is not required for this ticket, this to ensure that its design is compatible with this vision).
  • Introduce an automated syntax checker running on every build or merge (whatever is easier)

Definition of done

  • UI 'strings' from Guardian UI are stored in a separate file/module
  • Automates system is created to spell-check it

Acceptance criteria

Occurrences of misspellings in the Guardian UI are eliminated owing to the automated syntax checking of the UI 'strings' at build/packaging time.

Metadata

Metadata

Labels

No labels
No labels

Type

No fields configured for Epic.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions