Project

General

Profile

Actions

Documentation #6406

open

userguide: remove ambiguous "we" usages

Added by Juliana Fajardini Reichow about 1 year ago. Updated 4 months ago.

Status:
New
Priority:
Normal
Target version:
Affected Versions:
Effort:
Difficulty:
Label:
Beginner, Good First Issue, Outreachy

Description

Throughout the docs, there are several cases where the text mentioned "we" when in fact it's referring
to the user. In such cases, "we" should be replaced by "you" - or some other rewording.

One such example from https://docs.suricata.io/en/latest/rules/thresholding.html#type-threshold:
"This signature only generates an alert if we get 10 inbound emails or..."

This we actually means you (you, as in the user).

Cf discussion https://github.com/OISF/suricata/pull/9595#discussion_r1357496315

One way to go by this task is to split work by documentation chapters (depending on how much work there is to be done).

Actions #1

Updated by Juliana Fajardini Reichow about 1 year ago

  • Description updated (diff)
Actions #2

Updated by Juliana Fajardini Reichow about 1 year ago

  • Description updated (diff)
Actions #3

Updated by Victor Julien 6 months ago

  • Target version changed from 8.0.0-beta1 to TBD
Actions #4

Updated by Juliana Fajardini Reichow 4 months ago

  • Description updated (diff)
  • Label Beginner, Good First Issue, Outreachy added
Actions

Also available in: Atom PDF