Project

General

Profile

Actions

Documentation #6406

open
JF CO

userguide: remove ambiguous "we" usages

Documentation #6406: userguide: remove ambiguous "we" usages

Added by Juliana Fajardini Reichow over 2 years ago. Updated about 9 hours ago.

Status:
Assigned
Priority:
Normal
Assignee:
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).
The overall workflow tor this task should look somewhat like:
- submit a batch of changes (say, focusing on a single file);
- get feedback;
- incorporate feedback into a new PR;
- get new patch approved and merged;
- submit another batch of changes;
- iterate and repeat...

JF Updated by Juliana Fajardini Reichow over 2 years ago Actions #1

  • Description updated (diff)

JF Updated by Juliana Fajardini Reichow over 2 years ago Actions #2

  • Description updated (diff)

VJ Updated by Victor Julien almost 2 years ago Actions #3

  • Target version changed from 8.0.0-beta1 to TBD

JF Updated by Juliana Fajardini Reichow over 1 year ago Actions #4

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

CO Updated by Cheryl Owala 7 months ago Actions #5

Hello. May I please claim this issue and also be granted developer role please

VJ Updated by Victor Julien 7 months ago Actions #6

  • Status changed from New to Assigned
  • Assignee changed from Community Ticket to Cheryl Owala
  • Target version changed from TBD to 9.0.0-beta1

JF Updated by Juliana Fajardini Reichow 6 months ago Actions #7

  • Status changed from Assigned to In Progress

JF Updated by Juliana Fajardini Reichow 6 months ago Actions #8

  • Status changed from In Progress to In Review

JF Updated by Juliana Fajardini Reichow 5 months ago Actions #9

  • Description updated (diff)

PA Updated by Philippe Antoine about 9 hours ago Actions #11

  • Status changed from In Review to Assigned

Repuuting in assigned state as PR got closed as stale

Actions

Also available in: PDF Atom