From 5b63491fec831d0e298680c2a0c9ca317c3e7d97 Mon Sep 17 00:00:00 2001
From: Ciaran Ainsworth <ciaranainsworth@outlook.com>
Date: Thu, 20 Jan 2022 15:03:00 +0100
Subject: [PATCH] Start adding moderation rules docs

---
 docs/index.md                                 |  1 +
 .../domains/add_domain.md                     | 29 +++++++++++++++
 .../domains/add_rule.md                       |  1 +
 .../domains/edit_rule.md                      |  1 +
 docs/moderator_documentation/domains/index.md | 26 ++++++++++++++
 .../domains/purge_domain.md                   | 35 +++++++++++++++++++
 .../domains/remove_rule.md                    |  1 +
 7 files changed, 94 insertions(+)
 create mode 100644 docs/moderator_documentation/domains/add_domain.md
 create mode 100644 docs/moderator_documentation/domains/add_rule.md
 create mode 100644 docs/moderator_documentation/domains/edit_rule.md
 create mode 100644 docs/moderator_documentation/domains/index.md
 create mode 100644 docs/moderator_documentation/domains/purge_domain.md
 create mode 100644 docs/moderator_documentation/domains/remove_rule.md

diff --git a/docs/index.md b/docs/index.md
index 45112562c..da2fabbb7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -46,6 +46,7 @@ hidden: true
 
 moderator_documentation/index
 moderator_documentation/reports/index
+moderator_documentation/domains/index
 
 ```
 
diff --git a/docs/moderator_documentation/domains/add_domain.md b/docs/moderator_documentation/domains/add_domain.md
new file mode 100644
index 000000000..dc111785e
--- /dev/null
+++ b/docs/moderator_documentation/domains/add_domain.md
@@ -0,0 +1,29 @@
+# Add a domain to your pod's domain list
+
+Funkwhale records the domains of other {term}`Fediverse` servers when users interact with them. Once a domain is in your domains list, you can [add moderation rules](add_rules.md) to it. 
+
+You can also add domains to this list at any time to create rules before users interact with them. To do this:
+
+```{tabbed} Desktop
+
+1. Log in to your {term}`pod`.
+2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
+3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
+4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
+5. Enter the URL of the Fediverse server you want to add in the {guilabel}`Add a domain` field.
+6. Select {guilabel}`Add` to add the domain. The domain moderation page opens.
+
+```
+
+```{tabbed} Mobile
+
+1. Log in to your {term}`pod`.
+2. Select the wrench icon ({fa}`wrench`) at the top of the page to open the {guilabel}`Administration` menu.
+3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
+4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
+5. Enter the URL of the Fediverse server you want to add in the {guilabel}`Add a domain` field.
+6. Select {guilabel}`Add` to add the domain. The domain moderation page opens.
+
+```
+
+That's it! The domain is now in your domains list. You can now add moderation rules to this domain.
diff --git a/docs/moderator_documentation/domains/add_rule.md b/docs/moderator_documentation/domains/add_rule.md
new file mode 100644
index 000000000..eaf0a7830
--- /dev/null
+++ b/docs/moderator_documentation/domains/add_rule.md
@@ -0,0 +1 @@
+# Add a moderation rule
diff --git a/docs/moderator_documentation/domains/edit_rule.md b/docs/moderator_documentation/domains/edit_rule.md
new file mode 100644
index 000000000..8282881b4
--- /dev/null
+++ b/docs/moderator_documentation/domains/edit_rule.md
@@ -0,0 +1 @@
+# Edit a moderation rule
diff --git a/docs/moderator_documentation/domains/index.md b/docs/moderator_documentation/domains/index.md
new file mode 100644
index 000000000..02de08103
--- /dev/null
+++ b/docs/moderator_documentation/domains/index.md
@@ -0,0 +1,26 @@
+# Moderate external domains
+
+You can add moderation rules to control how your {term}`pod` interacts with other domains. Use these rules to control access to content and interaction with users on other pods.
+
+```{toctree}
+---
+caption: Manage external domains
+maxdepth: 1
+---
+
+add_domain
+purge_domain
+
+```
+
+```{toctree}
+---
+caption: Manage moderation rules
+maxdepth: 1
+---
+
+add_rule
+edit_rule
+remove_rule
+
+```
diff --git a/docs/moderator_documentation/domains/purge_domain.md b/docs/moderator_documentation/domains/purge_domain.md
new file mode 100644
index 000000000..1121a7d61
--- /dev/null
+++ b/docs/moderator_documentation/domains/purge_domain.md
@@ -0,0 +1,35 @@
+# Purge domain data
+
+```{warning}
+Purging a domain's data removes all objects and caches associated to that domain. This impacts users who have objects from these domains in their libraries.
+```
+
+When users follow content from another domain that content is visible on your {term}`pod`. If a domain hosts illegal or offensive content you can purge the content associated with it. To do this:
+
+```{tabbed} Desktop
+
+1. Log in to your {term}`pod`.
+2. Select the wrench icon ({fa}`wrench`) at the top of the sidebar to open the {guilabel}`Administration` menu.
+3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
+4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
+5. Select the checkbox ({fa}`square`) next to the domain(s) you want to purge. Selected domains show a tick ({fa}`check-square`).
+6. Select {guilabel}`Purge` in the {guilabel}`Actions` dropdown.
+7. Select {guilabel}`Go`. A {guilabel}`Do you want to launch purge on {count} items` warning appears.
+8. Select {guilabel}`Launch`.
+
+```
+
+```{tabbed} Mobile
+
+1. Log in to your {term}`pod`.
+2. Select the wrench icon ({fa}`wrench`) at the top of the screen to open the {guilabel}`Administration` menu.
+3. Select {guilabel}`Moderation`. The {guilabel}`Reports` page opens.
+4. Select {guilabel}`Domains` at the top of the page. The {guilabel}`Domains` page opens. You can see a list of known domains on this page.
+5. Select the checkbox ({fa}`square`) next to the domain(s) you want to purge. Selected domains show a tick ({fa}`check-square`).
+6. Select {guilabel}`Purge` in the {guilabel}`Actions` dropdown.
+7. Select {guilabel}`Go`. A {guilabel}`Do you want to launch purge on {count} items` warning appears.
+8. Select {guilabel}`Launch`.
+
+```
+
+You're done! Your pod clears all the content associated with the selected domains.
diff --git a/docs/moderator_documentation/domains/remove_rule.md b/docs/moderator_documentation/domains/remove_rule.md
new file mode 100644
index 000000000..d95a73289
--- /dev/null
+++ b/docs/moderator_documentation/domains/remove_rule.md
@@ -0,0 +1 @@
+# Remove a moderation rule