Add missing domain rules documentation

This commit is contained in:
Ciaran Ainsworth 2022-01-20 19:26:25 +01:00 committed by Ciarán Ainsworth
parent 5b63491fec
commit b533dd8f21
3 changed files with 117 additions and 1 deletions

View File

@ -1 +1,43 @@
# Add a moderation rule
```{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.
```
Add moderation rules to domains to control how they can interact with your {term}`pod`. Moderation rules enable you to restrict content from a domain showing on your pod.
To add a moderation rule to a domain:
```{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 domain you want to apply the rule to. The domain's moderation page opens.
6. Select {guilabel}`Add a moderation policy`. The moderation policy form appears.
7. Enter the {guilabel}`Reason` you are applying the rule. Depending on your pod's configuration, users may be able to see this.
8. Choose your moderation rule:
- {guilabel}`Block everything` purge all content from the domain and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Create` to save your rule.
```
```{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 domain you want to apply the rule to. The domain's moderation page opens.
6. Select {guilabel}`Add a moderation policy`. The moderation policy form appears.
7. Enter the {guilabel}`Reason` you are applying the rule. Depending on your pod's configuration, users may be able to see this.
8. Choose your moderation rule:
- {guilabel}`Block everything` purge all content from the domain and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Create` to save your rule.
```
That's all there is to it! You've applied your moderation rule. The rule takes effect as soon as you create it.

View File

@ -1 +1,45 @@
# Edit a moderation rule
```{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.
```
You can change a moderation rule on a domain at any time. 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 domain with the moderation rule you want to edit. The domain's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header. The moderation policy form opens.
7. __Optional__ Edit the following settings:
- {guilabel}`Enabled` toggle this switch to enable or disable the rule without deleting it.
- {guilabel}`Reason` update the reason for the moderation rule.
8. __Optional__ Update your moderation rule:
- {guilabel}`Block everything` purge all content from this domain and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Update` to save your rule.
```
```{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 domain with the moderation rule you want to edit. The domain's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header. The moderation policy form opens.
7. __Optional__ Edit the following settings:
- {guilabel}`Enabled` toggle this switch to enable or disable the rule without deleting it.
- {guilabel}`Reason` update the reason for the moderation rule.
8. __Optional__ Update your moderation rule:
- {guilabel}`Block everything` purge all content from this domain and block all content.
- {guilabel}`Reject media` only reject media files such as audio files, avatars, and album art.
9. Select {guilabel}`Update` to save your rule.
```
You're done! The changes to the rule take effect as soon as you update it.

View File

@ -1 +1,31 @@
# Remove a moderation rule
# Delete a moderation rule
If you no longer need a moderation rule, you can delete it completely. 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 domain with the moderation rule you want to edit. The domain's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header.. The moderation policy form opens.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.
```
```{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 domain with the moderation rule you want to edit. The domain's moderation page opens.
6. Select {guilabel}`Edit` under the {guilabel}`This domain is subject to specific moderation rules` header.. The moderation policy form opens.
8. Select {guilabel}`Delete`. A {guilabel}`Delete this moderation rule?` warning appears.
9. Select {guilabel}`Delete moderation rule`.
```
That's it! You've deleted your moderation rule. Content from the domain will no longer get blocked.