Skip to content

Docs: The bot's name "Danger" is unclear in context

Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.

Issue

The bot name "Danger" is too general. When mentioned in articles, it can be difficult to understand that it's the name of a specific bot and not an adjective.

Currently it is written with a capital letter, but this is not enough, especially when the name is at the beginning of a sentence and is already capitalized.

Browser translator also translates it as part of a sentence, making it seem like the reference is to some kind of "dangerous bots".

Example

From the old version of the community README:

  • Improve efficiency:
    • There is no longer a need to create a personal fork to get started contributing.
    • Danger runs automatically, without the need to configure personal access tokens and CI variables.
    • Pull mirroring keeps the community forks up to date, without regular manual rebasing.

Proposal

This word should stand out more clearly in the text to make it clear that this is a specific bot name.

Implementation plan

  • Methods of emphasis:

    1. Use straight quotation marks ("Danger").
      This is the standard literary form of emphasis.
    2. Use bold (Danger).
      This is widely used in GitLab documentation for many names and UI elements.
    3. Use backticks (Danger).
      This will prevent the browser translator from translating the name.
    4. Provide a link to the bot's documentation (Danger).
      This is very informative, but it's only appropriate to include a link the first time it's mentioned.
  • Places for documentation:

    1. On the style guide page (section Bold)
    2. In the word list page
Edited by n7800