Skip to content

Commit 4e386b6

Browse files
committed
Wrap standalone admonitions in horizontal rules
A common convention in technical writing is the "admonition", which adds supplemental information to the surrounding normal prose. These "admonitions" typically have a standardized styling that differentiates them from the rest of the prose in a visually prominent manner. This often includes putting a "box" around the text (either a border or a background color). Markdown doesn't have a dedicated admonition capability, but a standardized admonition style can be created using the general purpose markup. I have settled on the use of a leading and trailing horizontal rule (markup: `---`) to create something like a "box" around the admonition text.
1 parent 148cc48 commit 4e386b6

File tree

1 file changed

+40
-0
lines changed
  • content/categories/staff/moderation/_topics/moderator-instructions

1 file changed

+40
-0
lines changed

content/categories/staff/moderation/_topics/moderator-instructions/1.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,12 @@ Flags are used to bring things to the attention of the moderators. They may be s
6161

6262
Flags are shown on the ["Review" page](https://forum.arduino.cc/review). A moderator must review each flag and decide how it should be handled.
6363

64+
---
65+
6466
**Note:** there are some conditions where mention of products or services is allowed and not considered spam, which are listed [here](#exceptions).
6567

68+
---
69+
6670
<a name="user-submitted-flags"></a>
6771

6872
### [User-submitted flags](#user-submitted-flags)
@@ -339,8 +343,12 @@ A cross-post is when a user posts on the same subject to the forum multiple time
339343

340344
If multiple cross-posts have valuable replies, they must be preserved by merging into a single topic.
341345

346+
---
347+
342348
**Note:** The moved posts will be appended to the end of the thread of the topic they are moved to, regardless of the chronology of the posts.
343349

350+
---
351+
344352
1. Open the cross-post's topic.
345353
1. Click the wrench button ("topic actions") at the bottom of the topic.
346354
1. From the menu, select "**Select Posts...**". A **"You have selected 0 posts."** dialog will open.
@@ -357,10 +365,16 @@ If multiple cross-posts have valuable replies, they must be preserved by merging
357365

358366
A topic hijack is when a user makes a reply that is not relevant to the topic. This can either result in a confusing thread where there are multiple parallel discussions, or else one of the people needing help being forgotten about.
359367

368+
---
369+
360370
**Note:** a relevant reply to an old topic is not considered a hijack.
361371

372+
---
373+
362374
**Note:** cross-posts are sometimes done in the form of a hijack. In that case, follow the [**"Deal with cross-post"** instructions](#deal-with-cross-post).
363375

376+
---
377+
364378
1. Open the hijacked topic.
365379
1. Click the wrench button ("topic actions") at the bottom of the topic.
366380
1. From the menu, select "**Select Posts...**". A **"You have selected 0 posts."** dialog will open.
@@ -449,8 +463,12 @@ Users often create topics in [categories](https://forum.arduino.cc/categories) w
449463

450464
### [Delete post](#delete-post)
451465

466+
---
467+
452468
**Note:** be careful not to accidentally [delete the topic](#delete-topic) when you intended instead to only delete the last reply in the thread.
453469

470+
---
471+
454472
1. Click the **⬤⬤⬤** icon at the bottom of the post to be deleted.
455473
1. Click the trash can icon ("delete this post").
456474

@@ -483,8 +501,12 @@ The forum software provides some useful tools for investigating a user:
483501

484502
This is the tool used by staff and automated systems to store documentation related to a user account.
485503

504+
---
505+
486506
**Note:** User Notes are generated by [flags](#automated-system-submitted-flags) submitted by automated systems. These flags are regularly false positives. So be cautious in assigning importance to User Notes written by the `@system` user.
487507

508+
---
509+
488510
1. Open the user's profile page. This can be accessed by clicking their user name, then the user name in the profile preview popup.
489511
1. Click the **<kbd>User Notes</kbd>** button.
490512

@@ -527,8 +549,12 @@ This shows all staff actions that affected the user's account. The [User Notes](
527549

528550
"User Notes" provide a place for staff and automated systems to store documentation related to a user account. When a user has "User Notes", a **:memo:** icon is shown next to their user name. This icon can be clicked to view the notes.
529551

552+
---
553+
530554
**Note:** only moderators and administrators can see the icon and the notes. They are not visible to regular users.
531555

556+
---
557+
532558
Documenting inappropriate behavior or even suspicions of malicious intent (e.g., generic replies used to prepare a [spam](#delete-spam) account) generates [the history](#context) that will allow moderators to determine the appropriate level of action to take in response to future [inappropriate behavior](#deal-with-inappropriate-behavior).
533559

534560
---
@@ -564,8 +590,12 @@ User notes can be associated with a post. These are the same as the [User Notes
564590

565591
Moderators can mark their posts with a "Staff Color", which is intended to give it emphasis as an official proclamation.
566592

593+
---
594+
567595
**Note:** this is not the same as the similarly named "Staff Notice". Due to serving no useful purpose, "Staff Notices" should not be used.
568596

597+
---
598+
569599
1. Make a post as usual, whether that be a topic or reply.
570600
1. Click the **⬤⬤⬤** icon at the bottom of the post to be given the "Staff Color".
571601
1. Click the wrench icon.
@@ -597,8 +627,12 @@ Detailed information about Trust Levels: https://blog.discourse.org/2018/06/unde
597627

598628
The "Silence" action is used in cases where the intent is to temporarily curtail a user's forum activity in response to [inappropriate behavior](#deal-with-inappropriate-behavior), with the intent to later restore their privileges in hopes they can be reformed to a responsible member of the forum community.
599629

630+
---
631+
600632
**Note:** in cases where the intent is to permanently exclude the user from the Arduino Forum, the account should instead be ["Suspended"](#suspend-an-account).
601633

634+
---
635+
602636
1. Open the user's profile page. This can be accessed by clicking their user name, then the user name in the profile preview popup.
603637
1. Click the **<kbd>Admin</kbd>** button.
604638
1. From the **Permissions** section, click the **<kbd>Silence</kbd>** button.
@@ -616,10 +650,16 @@ The user is blocked from logging in to their account when it is suspended.
616650

617651
Account suspensions are used when the intention is to permanently exclude the user from the Arduino Forum.
618652

653+
---
654+
619655
**Note:** in cases where the intent is to temporarily curtail a user's forum activity in response to [inappropriate behavior](#deal-with-inappropriate-behavior), with the intent to later restore their privileges in hopes they can be reformed to a responsible member of the forum community, they should instead be ["Silenced"](#silence-user).
620656

657+
---
658+
621659
**Note:** Arduino has [a policy](https://forum.arduino.cc/t/about-user-account-deletion-and-user-content-deletion/627095/5) against deleting accounts, so you must not use the **Delete User** options the Discourse moderator interface often presents. Account suspensions are used instead. Suspensions are reversible in the event an error was discovered, which allows the moderators more freedom to take swift action.
622660

661+
---
662+
623663
1. Open the user's profile page. This can be accessed by clicking their user name, then the user name in the profile preview popup.
624664
1. Click the **<kbd>Admin</kbd>** button.
625665
1. From the **Permissions** section, click the **<kbd>:no_entry_sign: Suspend</kbd>** button.

0 commit comments

Comments
 (0)