Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added a new watch menu under training to explain the process of adding a watched item to SmokeDetector #95

Open
wants to merge 6 commits into
base: site
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion training/autoflagging.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# 5. Autoflagging
# 6. Autoflagging
In January 2017, we started [automatically flagging spam][meta] through metasmoke. This page
details that system.

Expand Down
2 changes: 1 addition & 1 deletion training/blacklister.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# 7. Further Privileges: Blacklister
# 8. Further Privileges: Blacklister
When you've been working within Charcoal for a while, there are further levels of privileges
that you may be interested in getting. One of these is blacklister (formerly known as "code admin"),
which deals with our blacklisting systems.
Expand Down
2 changes: 1 addition & 1 deletion training/core.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# 6. Further Privileges: Core
# 7. Further Privileges: Core
When you've been working within Charcoal for a while, there are further levels of privileges
that you may be interested in getting. For most people, the first of these is Core.

Expand Down
24 changes: 9 additions & 15 deletions training/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,13 @@ sure we're all doing it consistently.
## Introduction Index
This is a list of all the documents in this series. Start at the top and work your way down.

- [What's Charcoal?][1]
- [What's spam?][2]
- [Privileges][3]
- [Handling reports][4]
- [Autoflagging][5]
- [Further privileges: Core][7]
- [Further privileges: Blacklister][6]
1. [What's Charcoal?][/training/charcoal]
2. [What's spam?][/training/spam]
3. [When do you watch spam?][/training/watch]
4. [Privileges][/training/privileges]
5. [Handling reports][/training/reports]
6. [Autoflagging][/training/autoflagging]
7. [Further privileges: Core][/training/core]
8. [Further privileges: Blacklister][/training/blacklister]

[hq]: https://chat.stackexchange.com/rooms/11540/charcoal-hq
[1]: /training/charcoal
[2]: /training/spam
[3]: /training/privileges
[4]: /training/reports
[5]: /training/autoflagging
[6]: /training/blacklister
[7]: /training/core
[hq]: https://chat.stackexchange.com/rooms/11540/charcoal-hq
2 changes: 1 addition & 1 deletion training/privileges.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# 3. Privileges
# 4. Privileges
SmokeDetector has a limited number of [commands that are available for anyone to use][commandsNonPriv]. However,
all its major functionality requires additional "privileges" to use. Being a privileged user
means your user ID has been added to a list in SmokeDetector's code, which entitles you to
Expand Down
2 changes: 1 addition & 1 deletion training/reports.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
---

# 4. Handling reports
# 5. Handling reports
When a report comes into Charcoal HQ, there are two major things we need to do with it: flag
and feedback.

Expand Down
4 changes: 2 additions & 2 deletions training/spam.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,12 +86,12 @@ As always, use your best judgment, and ask if you're not sure.

-----

[Next: Privileges][3]
[Next: When to watch spam?][3]

[Return to Introduction Index][8]


[def]: https://meta.stackexchange.com/q/58032
[post]: https://metasmoke.erwaysoftware.com/post/108626
[3]: /training/privileges
[3]: /training/watch
[8]: /training/index
54 changes: 54 additions & 0 deletions training/watch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
---

# 3. When do you watch spam?
Adding websites and keywords to SmokeDetector's watchlists is a big part of being a privileged
user on Charcoal.

Unless a post is ***obvious*** spam, it can sometimes be a bit overwhelming to detect what is a
legit post and what is not. After you've checked a post, determined that it's spam and found the text
or website you want SmokeDetector to watch, we recommend doing a bit of research before adding it.

- **Search** for the URL or keyword on [Stack Exchange](https://stackexchange.com/)
- Use `url:example.com` in the search bar to find all questions and answers that have that website
in them. Check how many hits come up and if it's only the spam and 2-3 other posts it will
typically be OK to add it.
- Keywords can be searched just like normal text, but multiple keywords should be enclosed in
quotation marks. Example: `"key word"` and `"more words to search for"`. In this way it will
only show results for the actual text you search for. Stack Exchange will otherwise show results
for each searched word and this will typically return too many hits.
You can also use `code:keyword` to search for text that is hidden in a code snippet.
- **Search** [metasmoke](https://metasmoke.erwaysoftware.com/search) to see if anything already exist.
Maybe there's a lot of false positives, which would mean, that it shouldn't be added to the watchlist.
Metasmoke can be a bit complicated, but it can also be the best tool to find posts reported by
SmokeDetector. If you are good at regex it can be an advantage.
- Select `regex` in title, body and username. Now select `Use OR for text search (uses AND by default)`.
Enclose the text or URL you want to search for with `\b` and remember to escape functional regex
characters (`.` `()` `[]` etc.). You need to exclude `www.` from any URLs.
Example: Enter `\bsocket\.io\b` in title, body and username. It will now search for posts that
contain `socket.io` in either one or all of those fields. This broad search will make sure it catches
posts where spammers, for instance, have added a URL to only the title or maybe even in their username.
- **Check** [open pull requests](https://github.com/Charcoal-SE/SmokeDetector/pulls) on SmokeDetector
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be worth mentioning here to also check the history of chat messages after the report to see if someone else has already submitted a watch? But I'm not really sure this is all that critical. If there is a clash/conflict, you'll get a warning. The only harm is a little bit of noise and a little bit of unnecessary load on the SD/MS instance, neither of which seem like a good reason to overburden human volunteers.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not what the PRs show? You can quickly see if anything is added to the queue. Otherwise maybe people could run a test !!/test the thing they want to add first. Dunno.

Github. The watch you want to add might already be queued for approval. It's always a good idea to
check and make sure it's not a duplicate.

Cowm00 marked this conversation as resolved.
Show resolved Hide resolved
## Bookmarklets
To make life a bit easier, some users have made bookmarklets, that can do all the searching for you. Just
select and mark the text you want to search for in a report from SmokeDetector and then click the
bookmarklet. Depending on the version you choose to use, a new window will open in your browser and
automatically do the search for you (you might need to accept popups before the window open).

A bookmarklet is just a normal browser bookmark, where you add javascript code to the URL field. This will
then execute the code when you click the bookmark. Copy the javascript code and paste it
into the URL field and save it, then you should be good to go.

[List of bookmarklets](https://charcoal-se.org/bookmarklets/).

-----

[Next: Privileges][3]

[Return to Introduction Index][8]

[3]: /training/privileges
[8]: /training/index