Decide on the official term for authentication token
Problem to solve
The documentation states that authentication tokens are also called runner tokens.
Using alternating terms to describe the same object causes an inconsistent experience for the user. We should have one term for this type of token and this statement should be removed from the title: Runner authentication tokens (also called runner tokens).
A search of the documentation shows that runner tokens
is used less that authentication tokens
:
- runner token and runner tokens: 6 occurrences
- authentication token and authentication tokens: 124 occurrences
Proposal
- Reach a consensus about whether the official term is
runner token
orauthentication token
. Given that authentication token is used more predominantly throughout the documentation, perhaps it makes sense to settle onauthentication token
. - Remove the parenthetical phrase from the heading: Runner authentication tokens (also called runner tokens).
- Update docs to use official name.
- Update the Recommended word list.
- Update
runner token
in the create runner UI workflows (project, group, admin area).
Backend considerations
Will changing the terms 'runner token' and 'authentication token' impact any backend naming?
- Configuration variables
- Feature flag variables
- Command-line inputs/outputs
- API calls
Who can address the issue
TW for runner group with input from the PM or EM.
Other links/references
Edited by Fiona Neill