From 51dc2b001c31784beda2820b123479c2a5f0b79b Mon Sep 17 00:00:00 2001 From: Cow Date: Fri, 23 Aug 2024 21:42:10 +0200 Subject: [PATCH 1/7] Added watch and corrected links --- training/autoflagging.md | 2 +- training/core.md | 2 +- training/index.md | 18 ++++++++++-------- training/privileges.md | 2 +- training/reports.md | 2 +- training/spam.md | 4 ++-- training/watch.md | 29 +++++++++++++++++++++++++++++ 7 files changed, 45 insertions(+), 14 deletions(-) create mode 100644 training/watch.md diff --git a/training/autoflagging.md b/training/autoflagging.md index 9cceb6e5..1b97ee8d 100644 --- a/training/autoflagging.md +++ b/training/autoflagging.md @@ -1,7 +1,7 @@ --- --- -# 5. Autoflagging +# 6. Autoflagging In January 2017, we started [automatically flagging spam][meta] through metasmoke. This page details that system. diff --git a/training/core.md b/training/core.md index adf5c800..b04bf2c2 100644 --- a/training/core.md +++ b/training/core.md @@ -1,7 +1,7 @@ --- --- -# 6. Further Privileges: Core +# 8. 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. diff --git a/training/index.md b/training/index.md index 31c6e297..c8fb7fbb 100644 --- a/training/index.md +++ b/training/index.md @@ -23,17 +23,19 @@ This is a list of all the documents in this series. Start at the top and work yo - [What's Charcoal?][1] - [What's spam?][2] - - [Privileges][3] - - [Handling reports][4] - - [Autoflagging][5] + - [When do you watch spam?][3] + - [Privileges][4] + - [Handling reports][5] + - [Autoflagging][6] - [Further privileges: Core][7] - - [Further privileges: Blacklister][6] + - [Further privileges: Blacklister][8] [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 +[3]: /training/watch +[4]: /training/privileges +[5]: /training/reports +[6]: /training/autoflagging [7]: /training/core +[8]: /training/blacklister diff --git a/training/privileges.md b/training/privileges.md index 5681e677..c439fd79 100644 --- a/training/privileges.md +++ b/training/privileges.md @@ -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 diff --git a/training/reports.md b/training/reports.md index fa055364..5ffe3b79 100644 --- a/training/reports.md +++ b/training/reports.md @@ -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. diff --git a/training/spam.md b/training/spam.md index 9d3f9d9b..8cdf63f2 100644 --- a/training/spam.md +++ b/training/spam.md @@ -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 diff --git a/training/watch.md b/training/watch.md new file mode 100644 index 00000000..151c0bb1 --- /dev/null +++ b/training/watch.md @@ -0,0 +1,29 @@ +--- +--- + +# 3. When do you watch spam? +Adding websites and keywords to be watched by SmokeDetector 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 +keep up with new software terms, libraries and projects (nuget, chocolatey, mustache, etc.) and +know what is legit and what is not. We recommend doing a bit of research before you add a watch. + + - **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 has that website + in them. Check how many hits comes up and if it's only the spam and 2-3 other posts it will + typically be OK do 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. + - **Check** [open pull requests](https://github.com/Charcoal-SE/SmokeDetector/pulls) on SmokeDetector + 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. + +----- + +[Next: Privileges][3] + +[Return to Introduction Index][8] + +[3]: /training/privileges +[8]: /training/index From 0490151a87502679014d53922e2d11288bd817c2 Mon Sep 17 00:00:00 2001 From: Cow Date: Sat, 24 Aug 2024 14:07:37 +0200 Subject: [PATCH 2/7] gramma, order of menu items --- training/blacklister.md | 2 +- training/core.md | 2 +- training/index.md | 16 ++++++++-------- training/watch.md | 6 +++--- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/training/blacklister.md b/training/blacklister.md index 62d3ef3f..835fc2e8 100644 --- a/training/blacklister.md +++ b/training/blacklister.md @@ -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. diff --git a/training/core.md b/training/core.md index b04bf2c2..142b0c95 100644 --- a/training/core.md +++ b/training/core.md @@ -1,7 +1,7 @@ --- --- -# 8. 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. diff --git a/training/index.md b/training/index.md index c8fb7fbb..22796802 100644 --- a/training/index.md +++ b/training/index.md @@ -21,14 +21,14 @@ 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] - - [When do you watch spam?][3] - - [Privileges][4] - - [Handling reports][5] - - [Autoflagging][6] - - [Further privileges: Core][7] - - [Further privileges: Blacklister][8] +1. [What's Charcoal?][1] +2. [What's spam?][2] +3. [When do you watch spam?][3] +4. [Privileges][4] +5. [Handling reports][5] +6. [Autoflagging][6] +7. [Further privileges: Core][7] +8. [Further privileges: Blacklister][8] [hq]: https://chat.stackexchange.com/rooms/11540/charcoal-hq [1]: /training/charcoal diff --git a/training/watch.md b/training/watch.md index 151c0bb1..72321745 100644 --- a/training/watch.md +++ b/training/watch.md @@ -8,9 +8,9 @@ keep up with new software terms, libraries and projects (nuget, chocolatey, must know what is legit and what is not. We recommend doing a bit of research before you add a watch. - **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 has that website - in them. Check how many hits comes up and if it's only the spam and 2-3 other posts it will - typically be OK do add it. + - 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 From 056466378dc296562026f32ca6c8d00e1049dc19 Mon Sep 17 00:00:00 2001 From: Cow Date: Sat, 24 Aug 2024 21:37:03 +0200 Subject: [PATCH 3/7] Fixed things from Cody and more --- training/index.md | 26 +++++++++----------------- training/watch.md | 39 +++++++++++++++++++++++++++++++++++---- 2 files changed, 44 insertions(+), 21 deletions(-) diff --git a/training/index.md b/training/index.md index 22796802..83b00b4b 100644 --- a/training/index.md +++ b/training/index.md @@ -21,21 +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. -1. [What's Charcoal?][1] -2. [What's spam?][2] -3. [When do you watch spam?][3] -4. [Privileges][4] -5. [Handling reports][5] -6. [Autoflagging][6] -7. [Further privileges: Core][7] -8. [Further privileges: Blacklister][8] +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/watch -[4]: /training/privileges -[5]: /training/reports -[6]: /training/autoflagging -[7]: /training/core -[8]: /training/blacklister +[hq]: https://chat.stackexchange.com/rooms/11540/charcoal-hq \ No newline at end of file diff --git a/training/watch.md b/training/watch.md index 72321745..36460780 100644 --- a/training/watch.md +++ b/training/watch.md @@ -2,10 +2,12 @@ --- # 3. When do you watch spam? -Adding websites and keywords to be watched by SmokeDetector 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 -keep up with new software terms, libraries and projects (nuget, chocolatey, mustache, etc.) and -know what is legit and what is not. We recommend doing a bit of research before you add a watch. +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 @@ -15,10 +17,39 @@ know what is legit and what is not. We recommend doing a bit of research before 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 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. +## 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. + +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. When you copy the javascript code in the links below +it's important to convert it first to one line so that it can be pasted into the URL field. + +List of bookmarklets: + - **Makyen** [Link](https://chat.stackexchange.com/rooms/11540/conversation/bookmarklets-for-searching-ms-for-blacklisted-expressions) + - The general bookmarklet for searching on metasmoke is the third one called **For blacklisted websites**. + - **Ryan M** [Link](https://gist.github.com/ThatRyanPerson/c3d50439e41f5e19b2b4a51c5f8f88a9) + - This one will search both metasmoke, but will also open three additional windows that searches + Stack Exchange with all the proper keywords and formatting. It uses optimized regex for metasmoke + to minimize load. + ----- [Next: Privileges][3] From 83655f33b4b805f5aa121ed1c7185595e2e5b37c Mon Sep 17 00:00:00 2001 From: Cow Date: Tue, 27 Aug 2024 19:54:13 +0200 Subject: [PATCH 4/7] Changed bookmarklet description --- training/watch.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/training/watch.md b/training/watch.md index 36460780..296d76e3 100644 --- a/training/watch.md +++ b/training/watch.md @@ -39,8 +39,8 @@ bookmarklet. Depending on the version you choose to use, a new window will open automatically do the search for you. 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. When you copy the javascript code in the links below -it's important to convert it first to one line so that it can be pasted into the URL field. +then execute the code when you click the bookmark. Copy the javascript code in the links below and paste it +into the URL field, then you should be good to go. List of bookmarklets: - **Makyen** [Link](https://chat.stackexchange.com/rooms/11540/conversation/bookmarklets-for-searching-ms-for-blacklisted-expressions) From 6fe56cbee4c54d74390795e17798b8064def17b4 Mon Sep 17 00:00:00 2001 From: Cow Date: Sun, 8 Sep 2024 19:55:34 +0200 Subject: [PATCH 5/7] Updated bookmarklets with new link --- training/watch.md | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/training/watch.md b/training/watch.md index 296d76e3..0f2cb2d6 100644 --- a/training/watch.md +++ b/training/watch.md @@ -36,19 +36,13 @@ or website you want SmokeDetector to watch, we recommend doing a bit of research 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. +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 in the links below and paste it -into the URL field, then you should be good to go. - -List of bookmarklets: - - **Makyen** [Link](https://chat.stackexchange.com/rooms/11540/conversation/bookmarklets-for-searching-ms-for-blacklisted-expressions) - - The general bookmarklet for searching on metasmoke is the third one called **For blacklisted websites**. - - **Ryan M** [Link](https://gist.github.com/ThatRyanPerson/c3d50439e41f5e19b2b4a51c5f8f88a9) - - This one will search both metasmoke, but will also open three additional windows that searches - Stack Exchange with all the proper keywords and formatting. It uses optimized regex for metasmoke - to minimize load. +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/smokey/Bookmarklets). ----- From 1eaaf1e517db5e1d34a90cc705635a9e04c5023a Mon Sep 17 00:00:00 2001 From: Cow Date: Sun, 8 Sep 2024 21:01:03 +0200 Subject: [PATCH 6/7] updated link after change --- training/watch.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/training/watch.md b/training/watch.md index 0f2cb2d6..5b6f6cfe 100644 --- a/training/watch.md +++ b/training/watch.md @@ -42,7 +42,7 @@ A bookmarklet is just a normal browser bookmark, where you add javascript code t 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/smokey/Bookmarklets). +[List of bookmarklets](https://charcoal-se.org/bookmarklets/). ----- From f15cc94f247e4edf6da88546de0309743fb9cf2a Mon Sep 17 00:00:00 2001 From: tripleee Date: Thu, 21 Nov 2024 20:44:13 +0200 Subject: [PATCH 7/7] Use round parentheses instead of square brackets in link destinations Markdown syntax tweak --- training/index.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/training/index.md b/training/index.md index 83b00b4b..7e6ca262 100644 --- a/training/index.md +++ b/training/index.md @@ -21,13 +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. -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] +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 \ No newline at end of file