Overhaul end user documentation

docs/user_documentation/reports/index.md

@@ -0,0 +1,23 @@
+# Reporting
+
+```{note}
+{term}`Pod <Pod>` admins and moderators are responsible for handling reports. Pod admins can choose to allow anonymous (logged out) users to send reports. If you cannot send reports anonymously, contact the pod admin.
+```
+
+Funkwhale provides tools for reporting all content and accounts. You can report content for being objectionable or illegal. You can also report stolen content. Check out the guides in this section to see how to send a report.
+
+```{toctree}
+---
+caption: Submit reports
+maxdepth: 1
+---
+
+report_account
+report_channel
+report_library
+report_track
+report_album
+report_artist
+report_playlist
+
+```

docs/user_documentation/reports/report_account.md

@@ -0,0 +1,17 @@
+# Report an account
+
+You can report a user account if the user is breaking the {term}`pod's <Pod>` rules. To do this:
+
+1. Select the user's username to go to their profile page.
+2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
+3. Select {guilabel}`Report {username}`. A {guilabel}`Do you want to report this object?` menu appears.
+4. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report an account that features illegal content.
+   - __Offensive content__ – report an account that features offensive or abusive content.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+7. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+That's it! The pod's moderators can now action the report or contact you for clarification.

docs/user_documentation/reports/report_album.md

@@ -0,0 +1,18 @@
+# Report an album
+
+If an album violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
+
+1. Go to the album details page.
+2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
+3. Select {guilabel}`Report this album`. A {guilabel}`Do you want to report this object?` menu appears.
+4. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report an album that features illegal content.
+   - __Offensive content__ – report an album that features offensive or abusive content.
+   - __Invalid metadata__ – report that an album features invalid metadata.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+7. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+That's it! The pod's moderators can now action the report or contact you for clarification.

docs/user_documentation/reports/report_artist.md

@@ -0,0 +1,18 @@
+# Report an artist
+
+If an artist's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
+
+1. Go to the artist details page.
+2. Select {guilabel}`More…` to open the options menu.
+3. Select {guilabel}`Report this artist`. A {guilabel}`Do you want to report this object?` menu appears.
+4. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report an artist that features illegal content.
+   - __Offensive content__ – report an artist that features offensive or abusive content.
+   - __Invalid metadata__ – report that an artist's content features invalid metadata.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+7. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+That's it! The pod's moderators can now action the report or contact you for clarification.

docs/user_documentation/reports/report_channel.md

@@ -0,0 +1,18 @@
+# Report a channel
+
+If a channel's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
+
+1. Go to the channel's details page.
+2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
+3. Select {guilabel}`Report this channel`. A {guilabel}`Do you want to report this object?` menu appears.
+4. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report a channel that features illegal content.
+   - __Offensive content__ – report a channel that features offensive or abusive content.
+   - __Invalid metadata__ – report that a channel's content features invalid metadata.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+7. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+That's it! The pod's moderators can now action the report or contact you for clarification.

docs/user_documentation/reports/report_library.md

@@ -0,0 +1,18 @@
+# Report a library
+
+If a channel's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
+
+1. Go to the library's details page.
+2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
+3. Select {guilabel}`Report this library`. A {guilabel}`Do you want to report this object?` menu appears.
+4. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report a library that features illegal content.
+   - __Offensive content__ – report a library that features offensive or abusive content.
+   - __Invalid metadata__ – report that a library's content features invalid metadata.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+7. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+That's it! The pod's moderators can now action the report or contact you for clarification.

docs/user_documentation/reports/report_playlist.md

@@ -0,0 +1,42 @@
+# Report a playlist
+
+If a playlist's content violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
+
+```{tabbed} Desktop
+
+1. Select {menuselection}`Explore --> Playlists` in the sidebar. The {guilabel}`Browsing playlists` screen opens.
+2. Use the filters to search for a playlist.
+3. Select the three dot menu ({fa}`ellipsis-h`) to open the options menu.
+4. Select {guilabel}`Report this playlist`. A {guilabel}`Do you want to report this object?` menu appears.
+5. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report a playlist that features illegal content.
+   - __Offensive content__ – report a playlist that features offensive or abusive content.
+   - __Invalid metadata__ – report that a playlist's content features invalid metadata.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+6. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+7. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+8. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+```
+
+```{tabbed} Mobile
+
+1. Select the hamburger menu ({fa}`bars`) to open the menu bar.
+2. Select {menuselection}`Explore --> Playlists`. The {guilabel}`Browsing playlists` screen opens.
+3. Use the filters to search for a playlist.
+4. Select the three dot menu ({fa}`ellipsis-h`) to open the options menu.
+5. Select {guilabel}`Report this playlist`. A {guilabel}`Do you want to report this object?` menu appears.
+6. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report a playlist that features illegal content.
+   - __Offensive content__ – report a playlist that features offensive or abusive content.
+   - __Invalid metadata__ – report that a playlist's content features invalid metadata.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+7. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+8. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+9. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+```
+
+That's it! The pod's moderators can now action the report or contact you for clarification.

docs/user_documentation/reports/report_track.md

@@ -0,0 +1,18 @@
+# Report a track
+
+If a track violates a {term}`pod's <Pod>` rules or the law, you can report it. To do this:
+
+1. Go to the track details page or locate the track in a track table.
+2. Select the kebab menu ({fa}`ellipsis-v`) to open the options menu.
+3. Select {guilabel}`Report this track`. A {guilabel}`Do you want to report this object?` menu appears.
+4. Select a {guilabel}`Category`. Choose one of the following:
+   - __Takedown request__ – request removal of copyrighted material.
+   - __Illegal content__ –  report a track that features illegal content.
+   - __Offensive content__ – report a track that features offensive or abusive content.
+   - __Invalid metadata__ – report that a track features invalid metadata.
+   - __Other__ – submit details of your report in the {guilabel}`Message` field.
+5. __If you are not logged in__ – enter your {guilabel}`Email`. Pod moderators use this address to contact you.
+6. Enter details of your report in the {guilabel}`Message` field. Provide as much detail as possible here to help the moderators action the report.
+7. Select {guilabel}`Submit report` to send your report to the pod moderators.
+
+That's it! The pod's moderators can now action the report or contact you for clarification.