Documentation #6406
openuserguide: remove ambiguous "we" usages
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...
Updated by Juliana Fajardini Reichow about 2 years ago
- Description updated (diff)
Updated by Juliana Fajardini Reichow about 2 years ago
- Description updated (diff)
Updated by Victor Julien over 1 year ago
- Target version changed from 8.0.0-beta1 to TBD
Updated by Juliana Fajardini Reichow over 1 year ago
- Description updated (diff)
- Label Beginner, Good First Issue, Outreachy added
Updated by Cheryl Owala about 2 months ago
Hello. May I please claim this issue and also be granted developer role please
Updated by Victor Julien about 2 months ago
- Status changed from New to Assigned
- Assignee changed from Community Ticket to Cheryl Owala
- Target version changed from TBD to 9.0.0-beta1
Updated by Juliana Fajardini Reichow about 2 months ago
- Status changed from Assigned to In Progress
Updated by Juliana Fajardini Reichow about 2 months ago
- Status changed from In Progress to In Review
PR for review: https://github.com/OISF/suricata/pull/14054
Updated by Juliana Fajardini Reichow about 1 hour ago
- Description updated (diff)