Skip to content

Commit ed1257d

Browse files
committed
Don't bold quoting of non-prose references in "Moderator Instructions"
Technical writing such as the "Moderator Instructions" asset post is often littered with non-prose text such as references to: - UI elements - navigation items - product names The reader may have difficulty understanding when text is prose vs a reference to one of these items. For this reason, readability is improved by formatting the text so that there is a clear visual difference between the standard prose text and the non-prose items. This is done by employing several formatting techniques: - Bolding - Quoting Since the goal is only to emphasize the non-prose references, the quotes should not be bolded, so the nesting of the formatting markup must be done in the correct order. Some of the formatting was previously nested in the incorrect order, which resulted in inconsistent formatting and harmed readability.
1 parent f125ee6 commit ed1257d

File tree

1 file changed

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

1 file changed

+27
-27
lines changed

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

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -91,15 +91,15 @@ The ["**Review**" page](https://forum.arduino.cc/review) presents four options f
9191

9292
#### [Post flagged as "Off-Topic"](#post-flagged-as-off-topic)
9393

94-
See the [**"Move topic"**](#move-topic-to-correct-category) or [**"Split topic"**](#split-hijacked-topic) instructions.
94+
See the "[**Move topic**](#move-topic-to-correct-category)" or "[**Split topic**](#split-hijacked-topic)" instructions.
9595

9696
---
9797

9898
<a name="post-flagged-as-inappropriate"></a>
9999

100100
#### [Post flagged as "Inappropriate"](#post-flagged-as-inappropriate)
101101

102-
See the [**"Inappropriate behavior"**](#deal-with-inappropriate-behavior) instructions.
102+
See the ["**Inappropriate behavior**" instructions](#deal-with-inappropriate-behavior).
103103

104104
---
105105

@@ -118,10 +118,10 @@ See the [**"Inappropriate behavior"**](#deal-with-inappropriate-behavior) instru
118118
##### [If the post is spam](#if-the-post-is-spam)
119119

120120
1. Click the **<kbd>Yes ▾</kbd>** button.
121-
1. From the dropdown menu, click "**Suspend user**". The **"Suspend User"** dialog will open.
121+
1. From the dropdown menu, click "**Suspend user**". The "**Suspend User**" dialog will open.
122122
1. From the "**Suspend user until**" dropdown menu, select "**Forever**".
123123
1. In the "**Suspension Reason**" text field, enter "spam".
124-
1. From the **"What would you like to do with the associated post?"** dropdown menu, select "**Delete the post**".
124+
1. From the "**What would you like to do with the associated post?**" dropdown menu, select "**Delete the post**".
125125
1. Click the **<kbd>:no_entry_sign: Suspend</kbd>** button.
126126

127127
---
@@ -133,12 +133,12 @@ See the [**"Inappropriate behavior"**](#deal-with-inappropriate-behavior) instru
133133
The user submitting a "**Something Else**" flag will provide a message explaining the purpose of the flag. This might be used to flag problematic posts that don't fit into any of the standard user-submitted flag categories, or simply as an efficient means of communicating with the moderators about a benign post (e.g., requesting a tutorial topic be closed to discussion).
134134

135135
1. [Review the flag](#review-flag).
136-
1. If the flag warranted action, resolve it, following the relevant instructions provided elsewhere in this document. In cases where an **"Yes"** review was warranted but you are unable to take the external action to resolve the flag, just select **"Keep post"** from the **<kbd>Yes ▾</kbd>** menu. A message is generated in the [**"Moderators"** messages folder](https://forum.arduino.cc/my/messages/group/moderators) for each "**Something Else**" flag, and this message will be used to track the request.
137-
1. A private message is generated for each "**Something Else**" flag. This can be accessed directly via the flag's **<kbd>view full conversation</kbd>** button, or the [**"Moderators"** messages folder](https://forum.arduino.cc/my/messages/group/moderators). If the flag was resolved by the review interface itself, this message will automatically be archived. However, it is often not possible to resolve the flag via the review interface (e.g., [moving](#move-topic-to-correct-category) a topic to the appropriate category). In this case, the message must be manually archived by clicking its **<kbd>:file_folder: Archive</kbd>** button.
136+
1. If the flag warranted action, resolve it, following the relevant instructions provided elsewhere in this document. In cases where an "**Yes**" review was warranted but you are unable to take the external action to resolve the flag, just select "**Keep post**" from the <kbd>**Yes ▾**</kbd> menu. A message is generated in the ["**Moderators**" messages folder](https://forum.arduino.cc/my/messages/group/moderators) for each "**Something Else**" flag, and this message will be used to track the request.
137+
1. A private message is generated for each "**Something Else**" flag. This can be accessed directly via the flag's **<kbd>view full conversation</kbd>** button, or the ["**Moderators**" messages folder](https://forum.arduino.cc/my/messages/group/moderators). If the flag was resolved by the review interface itself, this message will automatically be archived. However, it is often not possible to resolve the flag via the review interface (e.g., [moving](#move-topic-to-correct-category) a topic to the appropriate category). In this case, the message must be manually archived by clicking its **<kbd>:file_folder: Archive</kbd>** button.
138138

139139
![Archive message|356x500, 50%](https://europe1.discourse-cdn.com/arduino/original/4X/0/e/c/0ec0938faf6e77029655ff167701d3ca16bbdd3f.png)
140140

141-
**WARNING:** the [**"Moderators"** messages folder](https://forum.arduino.cc/my/messages/group/moderators) is shared between all the moderators. When you take an action it affects the inbox for everyone.
141+
**WARNING:** the ["**Moderators**" messages folder](https://forum.arduino.cc/my/messages/group/moderators) is shared between all the moderators. When you take an action it affects the inbox for everyone.
142142

143143
---
144144

@@ -217,10 +217,10 @@ This flag is created by **`@system`** when a new user created a topic, and anoth
217217
##### [If the post is malicious](#if-the-post-is-malicious-2)
218218

219219
1. Click the **<kbd>Yes ▾</kbd>** button.
220-
1. From the dropdown menu, click "**Suspend User**". The **"Suspend User"** dialog will open.
220+
1. From the dropdown menu, click "**Suspend User**". The "**Suspend User**" dialog will open.
221221
1. From the "**Select a timeframe**" dropdown menu, select "**Forever**".
222222
1. In the "**Suspension Reason**" text field, enter "malicious use of multiple accounts".
223-
1. From the **"What would you like to do with the associated post?"** dropdown menu, select "**Delete the post**".
223+
1. From the "**What would you like to do with the associated post?**" dropdown menu, select "**Delete the post**".
224224
1. Click the **<kbd>:no_entry_sign: Suspend</kbd>** button.
225225

226226
---
@@ -282,16 +282,16 @@ Mentions of relevant products or services of interest to the Arduino community a
282282
1. Click the **:black_flag:** icon.
283283
1. Click the "**It's Spam**" radio button.
284284
1. Click the **<kbd>Take Action... ▾</kbd>** button.
285-
1. From the dropdown menu, click "**Suspend User**". The **"Suspend User"** dialog will open.
285+
1. From the dropdown menu, click "**Suspend User**". The "**Suspend User**" dialog will open.
286286
1. From the "**Suspend user until**" dropdown menu, select "**Forever**".
287287
1. In the "**Suspension Reason**" text field, enter "spam".
288-
1. From the **"What would you like to do with the associated post?"** dropdown menu, select "**Delete the post**".
288+
1. From the "**What would you like to do with the associated post?**" dropdown menu, select "**Delete the post**".
289289
1. Click the **<kbd>:no_entry_sign: Suspend</kbd>** button.
290290
1. Click the spammer's user name.
291291
1. Click the spammer's user name in the profile preview popup.
292-
1. Click the **"Activity"** tab to see their other posts.
292+
1. Click the "**Activity**" tab to see their other posts.
293293
1. Open any other spam posts they have made.
294-
1. Follow the [**"Delete post"**](#delete-post) or [**"Delete topic"**](#delete-topic) instructions to delete the additional spam.
294+
1. Follow the "[**Delete post**](#delete-post)" or "[**Delete topic**](#delete-topic)" instructions to delete the additional spam.
295295

296296
---
297297

@@ -305,7 +305,7 @@ Topics written in a language for which there is not a dedicated board may be lef
305305

306306
1. If you don't know the language or, in the case of language categories with sub-categories, subject, copy the post text and paste it into [**Google Translate**](https://translate.google.com). This will detect the language and allow you to determine the subject matter.
307307
**Note:** it's easy for someone unfamiliar with the language to mistake Portuguese for Spanish.
308-
1. Follow the **["Move topic to correct category" instructions](#move-topic-to-correct-category)** to move the topic to the appropriate category.
308+
1. Follow the ["**Move topic to correct category**" instructions](#move-topic-to-correct-category) to move the topic to the appropriate category.
309309

310310
---
311311

@@ -319,7 +319,7 @@ A cross-post is when a user posts on the same subject to the forum multiple time
319319
1. Click the **"Activity"** tab to see their posts.
320320
1. Pick one of the cross-posts to keep. If only one cross-post has valuable replies, keep that one. The cross-post that is in the appropriate forum board has preference.
321321
1. Follow the instructions below to [delete](#if-the-post-to-be-removed-has-no-valuable-replies) or [merge](#if-the-post-to-be-removed-has-valuable-replies) the other cross-posts.
322-
1. Add a [**"User Note"**](#add-user-note) to document the rule violation. If the user notes indicate a history of repeated cross-posting, take more severe moderation action, as described in the [**"Deal with inappropriate behavior"**](#deal-with-inappropriate-behavior) instructions.
322+
1. Add a "[**User Note**](#add-user-note)" to document the rule violation. If the user notes indicate a history of repeated cross-posting, take more severe moderation action, as described in the "[**Deal with inappropriate behavior**](#deal-with-inappropriate-behavior)" instructions.
323323
1. In a reply to the cross-post to be kept, add a ["Staff Post"](#make-staff-post):
324324
> I've deleted/merged your other cross-post(s).
325325
>
@@ -335,7 +335,7 @@ A cross-post is when a user posts on the same subject to the forum multiple time
335335

336336
##### [If the post to be removed has no valuable replies](#if-the-post-to-be-removed-has-no-valuable-replies)
337337

338-
1. Follow the [**"Delete post"**](#delete-post) or [**"Delete topic"**](#delete-topic) instructions.
338+
1. Follow the "[**Delete post**](#delete-post)" or "[**Delete topic**](#delete-topic)" instructions.
339339

340340
<a name="if-the-post-to-be-removed-has-valuable-replies"></a>
341341

@@ -351,9 +351,9 @@ If multiple cross-posts have valuable replies, they must be preserved by merging
351351

352352
1. Open the cross-post's topic.
353353
1. Click the wrench button ("topic actions") at the bottom of the topic.
354-
1. From the menu, select "**Select Posts...**". A **"You have selected 0 posts."** dialog will open.
354+
1. From the menu, select "**Select Posts...**". A "**You have selected 0 posts.**" dialog will open.
355355
1. If the entire thread is related to the cross-post, click "**select all**" in the dialog. If the cross-post was a [thread hijack](#split-hijacked-topic), then click the **<kbd>select</kbd>** button on each post related to the cross-post.
356-
1. Click the **<kbd>move to</kbd>** button. A **"Move to"** dialog will open.
356+
1. Click the **<kbd>move to</kbd>** button. A "**Move to**" dialog will open.
357357
1. Use the **"Search for a Topic"** field to find the cross-post topic to be kept. This can be done by entering its topic ID, which is the number at the end of the topic's URL. For example, the ID of this topic (`https://forum.arduino.cc/t/moderator-instructions/630548`) is `630548`.
358358
1. Click the **<kbd>Move to Existing Topic</kbd>** button.
359359

@@ -371,17 +371,17 @@ A topic hijack is when a user makes a reply that is not relevant to the topic. T
371371

372372
---
373373

374-
**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).
374+
**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).
375375

376376
---
377377

378378
1. Open the hijacked topic.
379379
1. Click the wrench button ("topic actions") at the bottom of the topic.
380-
1. From the menu, select "**Select Posts...**". A **"You have selected 0 posts."** dialog will open.
380+
1. From the menu, select "**Select Posts...**". A "**You have selected 0 posts.**" dialog will open.
381381
1. Click the **<kbd>select</kbd>** button on each post related to the hijack.
382-
1. Click the **<kbd>move to</kbd>** button. A **"Move to"** dialog will open.
383-
1. In the **"New Topic Title"** field, enter an appropriate title for the subject of the hijack post.
384-
1. Select the appropriate [forum category](https://forum.arduino.cc/categories) from the **"Category"** dropdown menu.
382+
1. Click the **<kbd>move to</kbd>** button. A "**Move to**" dialog will open.
383+
1. In the "**New Topic Title**" field, enter an appropriate title for the subject of the hijack post.
384+
1. Select the appropriate [forum category](https://forum.arduino.cc/categories) from the "**Category**" dropdown menu.
385385
1. Click the **<kbd>Move to New Topic</kbd>** button. The new topic will be created and opened in your browser.
386386
1. In a reply to the newly created topic, add a ["Staff Post"](#make-staff-post):
387387
> Please don't hijack topics. I've had to split your post out to its own topic.
@@ -518,7 +518,7 @@ This shows the user's posts, which can be used to find unreported inappropriate
518518

519519
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.
520520
- If any of their posts have been deleted, there will be a black bar at the top of the user profile "**Summary**" page with a "**deleted posts**" link. Click that link to see the deleted posts.
521-
- Click the **"Activity"** tab to see their other posts.
521+
- Click the "**Activity**" tab to see their other posts.
522522

523523
<a name="ip-lookup"></a>
524524

@@ -529,7 +529,7 @@ This tool allows you to see all the accounts associated with the user's [IP addr
529529
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.
530530
1. Click the **<kbd>Admin</kbd>** button.
531531
1. Click the **<kbd>:globe_with_meridians: IP Lookup</kbd>** button.
532-
1. Check whether any other accounts are listed under the **"Other accounts with this IP address"** section.
532+
1. Check whether any other accounts are listed under the "**Other accounts with this IP address**" section.
533533

534534
<a name="action-logs"></a>
535535

@@ -567,7 +567,7 @@ User notes can be associated with a post. These are the same as the [User Notes
567567

568568
1. Click the **⬤⬤⬤** icon at the bottom of the post.
569569
1. Click the wrench icon.
570-
1. Click **"Add User Note"**.
570+
1. Click "**Add User Note**".
571571
1. Write the User Note.
572572
1. Click the **<kbd>Add User Note</kbd>** button.
573573

@@ -599,7 +599,7 @@ Moderators can mark their posts with a "Staff Color", which is intended to give
599599
1. Make a post as usual, whether that be a topic or reply.
600600
1. Click the **⬤⬤⬤** icon at the bottom of the post to be given the "Staff Color".
601601
1. Click the wrench icon.
602-
1. Click **"Add Staff Color"**.
602+
1. Click "**Add Staff Color**".
603603

604604
---
605605

0 commit comments

Comments
 (0)