From 65316d43c130ee8d9e458b9490c7d5cb9a007b53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Wed, 1 Feb 2023 13:41:44 +0100 Subject: [PATCH] docs: rearrange paths, update links and redirects Part-of: --- .../configuration}/change_url.md | 2 +- .../configuration}/env_file.md | 2 +- .../configuration}/frontend.md | 0 .../configuration}/index.md | 0 .../configuration}/instance_settings.md | 4 +- .../configuration}/ldap.md | 0 .../configuration}/mrf.md | 2 +- .../configuration}/object_storage.md | 0 .../configuration}/optimize.md | 0 .../configuration}/rate-limiting.md | 0 .../django/delete_content.md | 2 +- .../django/index.md | 0 .../index.md => administrator/import.md} | 8 +- .../index.md | 8 +- .../installation}/debian.md | 0 .../installation}/docker.md | 0 .../installation}/index.md | 0 .../installation}/migrate.md | 2 +- .../installation}/quick_install.md | 0 .../installation}/third_party.md | 0 .../manage_script/create_library.md | 16 +-- .../manage_script/database.md | 2 +- .../manage_script/fix_uploads.md | 0 .../manage_script/index.md | 0 .../manage_script/library.md | 2 +- .../manage_script/tags.md | 0 .../manage_script/thumbnails.md | 0 .../manage_script/users.md | 0 .../migration_guide.md} | 0 .../troubleshooting/backend.md | 2 +- .../troubleshooting/frontend.md | 0 .../troubleshooting/get_help.md | 0 .../troubleshooting/index.md | 0 .../uninstall}/debian.md | 6 +- .../uninstall}/docker.md | 4 +- .../uninstall}/index.md | 0 .../uninstall}/quick_install.md | 6 +- .../upgrade}/backup.md | 0 .../upgrade}/debian.md | 6 +- .../upgrade}/docker.md | 2 +- .../upgrade}/index.md | 0 .../upgrade}/quick_install.md | 2 +- .../documentation.md | 2 +- .../index.md | 2 +- .../translation.md | 0 .../api/authentication.md | 0 .../api/index.md | 0 .../api/rate_limit.md | 0 .../api/subsonic.md | 0 .../architecture.md | 0 .../contribute/api.md | 0 .../contribute/copy.md | 0 .../contribute/frontend.md | 0 .../contribute/index.md | 0 .../federation/index.md | 0 .../index.md | 0 .../plugins/create.md | 0 .../plugins/index.md | 0 .../plugins/install.md | 0 .../setup/docker.md | 0 .../setup/gitpod-select-gitpod-in-gitlab.png | Bin .../setup/gitpod.md | 0 .../setup/index.md | 0 .../setup/vite.md | 0 .../workflows/changelog.md | 0 .../workflows/git.md | 0 .../workflows/index.md | 0 .../workflows/pre-commit.md | 0 .../workflows/release.md | 0 docs/index.md | 90 +++++++-------- .../allow_listing/add.md} | 0 .../allow_listing/index.md | 6 +- .../allow_listing/remove.md} | 0 .../content/delete.md} | 0 .../content/edits.md} | 0 .../content/index.md | 6 +- .../content/library.md} | 0 .../domains/add.md} | 2 +- .../domains/index.md | 10 +- .../domains/purge.md} | 0 .../domains/rules/add.md} | 0 .../domains/rules/delete.md} | 0 .../domains/rules/edit.md} | 0 .../external_users/index.md | 8 +- .../external_users/purge.md} | 0 .../external_users/rules/add.md} | 0 .../external_users/rules/delete.md} | 0 .../external_users/rules/edit.md} | 0 .../index.md | 0 .../internal_users/index.md | 4 +- .../internal_users/registration.md} | 0 .../reports/content.md} | 12 +- .../reports/index.md | 10 +- .../reports/notes.md} | 8 +- .../reports/search.md} | 2 +- .../reports/users.md} | 6 +- .../reports/view.md} | 2 +- docs/redirects.txt | 105 +++++++++--------- .../accounts/activity.md} | 0 .../accounts/avatar/add.md} | 0 .../accounts/avatar/delete.md} | 0 .../accounts/create.md} | 0 .../accounts/delete.md} | 2 +- .../accounts/email.md} | 0 .../accounts/index.md | 16 +-- .../accounts/password.md} | 0 .../check_quota.md => user/accounts/quota.md} | 0 .../channels/artist/delete.md} | 4 +- .../channels/artist/upload.md} | 2 +- .../channels/create.md} | 4 +- .../channels/delete.md} | 0 .../edit_channel.md => user/channels/edit.md} | 0 .../channels/follow.md} | 0 .../channels/index.md | 18 +-- .../channels/podcast/delete.md} | 4 +- .../channels/podcast/upload.md} | 2 +- .../subscribe_rss.md => user/channels/rss.md} | 0 .../favorites/add.md} | 0 .../favorites/index.md | 4 +- .../favorites/remove.md} | 0 docs/{user_documentation => user}/index.md | 0 .../{user_documentation => user}/info/cli.rst | 0 .../libraries/content/delete.md} | 0 .../libraries/content/edit.md} | 2 +- .../libraries/content/tag.md} | 2 +- .../libraries/content/upload.md} | 2 +- .../libraries/create.md} | 0 .../libraries/delete.md} | 0 .../libraries/edit.md} | 0 .../libraries/follow.md} | 0 .../libraries/index.md | 18 +-- .../libraries/share.md} | 0 .../playlists/content/add.md} | 2 +- .../playlists/content/remove.md} | 0 .../playlists/content/reorder.md} | 0 .../playlists/create.md} | 2 +- .../playlists/delete.md} | 0 .../playlists/edit.md} | 0 .../playlists/index.md | 14 +-- .../playlists/listen.md} | 2 +- .../plugins/index.md | 6 +- .../plugins/listenbrainz.md} | 0 .../plugins/maloja.md} | 0 .../plugins/scrobbler.md} | 2 +- .../add_album.md => user/queue/album.md} | 0 .../add_artist.md => user/queue/artist.md} | 0 .../queue/index.md | 14 +-- .../queue/playlist.md} | 0 .../queue/rearrange.md} | 0 .../queue/remove.md} | 0 .../add_series.md => user/queue/series.md} | 0 .../add_tracks.md => user/queue/tracks.md} | 0 .../create_radio.md => user/radios/create.md} | 0 .../delete_radio.md => user/radios/delete.md} | 2 +- .../edit_radio.md => user/radios/edit.md} | 0 .../radios/index.md | 8 +- .../listen_radio.md => user/radios/listen.md} | 2 +- .../reports/account.md} | 0 .../report_album.md => user/reports/album.md} | 0 .../reports/artist.md} | 0 .../reports/channel.md} | 0 .../reports/index.md | 14 +-- .../reports/library.md} | 0 .../reports/playlist.md} | 0 .../report_track.md => user/reports/track.md} | 0 .../subsonic/disable.md} | 2 +- .../subsonic/index.md | 6 +- .../subsonic/password/request.md} | 0 .../subsonic/password/reset.md} | 0 169 files changed, 254 insertions(+), 255 deletions(-) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/change_url.md (97%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/env_file.md (98%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/frontend.md (100%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/index.md (100%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/instance_settings.md (97%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/ldap.md (100%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/mrf.md (98%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/object_storage.md (100%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/optimize.md (100%) rename docs/{administrator_documentation/configuration_docs => administrator/configuration}/rate-limiting.md (100%) rename docs/{administrator_documentation => administrator}/django/delete_content.md (96%) rename docs/{administrator_documentation => administrator}/django/index.md (100%) rename docs/{administrator_documentation/import_docs/index.md => administrator/import.md} (95%) rename docs/{administrator_documentation => administrator}/index.md (52%) rename docs/{administrator_documentation/installation_docs => administrator/installation}/debian.md (100%) rename docs/{administrator_documentation/installation_docs => administrator/installation}/docker.md (100%) rename docs/{administrator_documentation/installation_docs => administrator/installation}/index.md (100%) rename docs/{administrator_documentation/installation_docs => administrator/installation}/migrate.md (97%) rename docs/{administrator_documentation/installation_docs => administrator/installation}/quick_install.md (100%) rename docs/{administrator_documentation/installation_docs => administrator/installation}/third_party.md (100%) rename docs/{administrator_documentation => administrator}/manage_script/create_library.md (69%) rename docs/{administrator_documentation => administrator}/manage_script/database.md (93%) rename docs/{administrator_documentation => administrator}/manage_script/fix_uploads.md (100%) rename docs/{administrator_documentation => administrator}/manage_script/index.md (100%) rename docs/{administrator_documentation => administrator}/manage_script/library.md (97%) rename docs/{administrator_documentation => administrator}/manage_script/tags.md (100%) rename docs/{administrator_documentation => administrator}/manage_script/thumbnails.md (100%) rename docs/{administrator_documentation => administrator}/manage_script/users.md (100%) rename docs/{administrator_documentation/migration_guide/index.md => administrator/migration_guide.md} (100%) rename docs/{administrator_documentation => administrator}/troubleshooting/backend.md (97%) rename docs/{administrator_documentation => administrator}/troubleshooting/frontend.md (100%) rename docs/{administrator_documentation => administrator}/troubleshooting/get_help.md (100%) rename docs/{administrator_documentation => administrator}/troubleshooting/index.md (100%) rename docs/{administrator_documentation/uninstall_docs => administrator/uninstall}/debian.md (95%) rename docs/{administrator_documentation/uninstall_docs => administrator/uninstall}/docker.md (95%) rename docs/{administrator_documentation/uninstall_docs => administrator/uninstall}/index.md (100%) rename docs/{administrator_documentation/uninstall_docs => administrator/uninstall}/quick_install.md (95%) rename docs/{administrator_documentation/upgrade_docs => administrator/upgrade}/backup.md (100%) rename docs/{administrator_documentation/upgrade_docs => administrator/upgrade}/debian.md (81%) rename docs/{administrator_documentation/upgrade_docs => administrator/upgrade}/docker.md (98%) rename docs/{administrator_documentation/upgrade_docs => administrator/upgrade}/index.md (100%) rename docs/{administrator_documentation/upgrade_docs => administrator/upgrade}/quick_install.md (66%) rename docs/{contributor_documentation => contributor}/documentation.md (98%) rename docs/{contributor_documentation => contributor}/index.md (92%) rename docs/{contributor_documentation => contributor}/translation.md (100%) rename docs/{developer_documentation => developer}/api/authentication.md (100%) rename docs/{developer_documentation => developer}/api/index.md (100%) rename docs/{developer_documentation => developer}/api/rate_limit.md (100%) rename docs/{developer_documentation => developer}/api/subsonic.md (100%) rename docs/{developer_documentation => developer}/architecture.md (100%) rename docs/{developer_documentation => developer}/contribute/api.md (100%) rename docs/{developer_documentation => developer}/contribute/copy.md (100%) rename docs/{developer_documentation => developer}/contribute/frontend.md (100%) rename docs/{developer_documentation => developer}/contribute/index.md (100%) rename docs/{developer_documentation => developer}/federation/index.md (100%) rename docs/{developer_documentation => developer}/index.md (100%) rename docs/{developer_documentation => developer}/plugins/create.md (100%) rename docs/{developer_documentation => developer}/plugins/index.md (100%) rename docs/{developer_documentation => developer}/plugins/install.md (100%) rename docs/{developer_documentation => developer}/setup/docker.md (100%) rename docs/{developer_documentation => developer}/setup/gitpod-select-gitpod-in-gitlab.png (100%) rename docs/{developer_documentation => developer}/setup/gitpod.md (100%) rename docs/{developer_documentation => developer}/setup/index.md (100%) rename docs/{developer_documentation => developer}/setup/vite.md (100%) rename docs/{developer_documentation => developer}/workflows/changelog.md (100%) rename docs/{developer_documentation => developer}/workflows/git.md (100%) rename docs/{developer_documentation => developer}/workflows/index.md (100%) rename docs/{developer_documentation => developer}/workflows/pre-commit.md (100%) rename docs/{developer_documentation => developer}/workflows/release.md (100%) rename docs/{moderator_documentation/allow_listing/add_domain.md => moderator/allow_listing/add.md} (100%) rename docs/{moderator_documentation => moderator}/allow_listing/index.md (85%) rename docs/{moderator_documentation/allow_listing/remove_domain.md => moderator/allow_listing/remove.md} (100%) rename docs/{moderator_documentation/content/delete_content.md => moderator/content/delete.md} (100%) rename docs/{moderator_documentation/content/handle_edits.md => moderator/content/edits.md} (100%) rename docs/{moderator_documentation => moderator}/content/index.md (84%) rename docs/{moderator_documentation/content/library_visibility.md => moderator/content/library.md} (100%) rename docs/{moderator_documentation/domains/add_domain.md => moderator/domains/add.md} (96%) rename docs/{moderator_documentation => moderator}/domains/index.md (86%) rename docs/{moderator_documentation/domains/purge_domain.md => moderator/domains/purge.md} (100%) rename docs/{moderator_documentation/domains/add_rule.md => moderator/domains/rules/add.md} (100%) rename docs/{moderator_documentation/domains/delete_rule.md => moderator/domains/rules/delete.md} (100%) rename docs/{moderator_documentation/domains/edit_rule.md => moderator/domains/rules/edit.md} (100%) rename docs/{moderator_documentation => moderator}/external_users/index.md (89%) rename docs/{moderator_documentation/external_users/purge_users.md => moderator/external_users/purge.md} (100%) rename docs/{moderator_documentation/external_users/add_rule.md => moderator/external_users/rules/add.md} (100%) rename docs/{moderator_documentation/external_users/delete_rule.md => moderator/external_users/rules/delete.md} (100%) rename docs/{moderator_documentation/external_users/edit_rule.md => moderator/external_users/rules/edit.md} (100%) rename docs/{moderator_documentation => moderator}/index.md (100%) rename docs/{moderator_documentation => moderator}/internal_users/index.md (90%) rename docs/{moderator_documentation/internal_users/handle_registration.md => moderator/internal_users/registration.md} (100%) rename docs/{moderator_documentation/reports/handle_content.md => moderator/reports/content.md} (90%) rename docs/{moderator_documentation => moderator}/reports/index.md (93%) rename docs/{moderator_documentation/reports/internal_notes.md => moderator/reports/notes.md} (93%) rename docs/{moderator_documentation/reports/search_reports.md => moderator/reports/search.md} (93%) rename docs/{moderator_documentation/reports/handle_users.md => moderator/reports/users.md} (77%) rename docs/{moderator_documentation/reports/view_reports.md => moderator/reports/view.md} (94%) rename docs/{user_documentation/accounts/activity_visibility.md => user/accounts/activity.md} (100%) rename docs/{user_documentation/accounts/add_avatar.md => user/accounts/avatar/add.md} (100%) rename docs/{user_documentation/accounts/delete_avatar.md => user/accounts/avatar/delete.md} (100%) rename docs/{user_documentation/accounts/create_account.md => user/accounts/create.md} (100%) rename docs/{user_documentation/accounts/delete_account.md => user/accounts/delete.md} (97%) rename docs/{user_documentation/accounts/change_email.md => user/accounts/email.md} (100%) rename docs/{user_documentation => user}/accounts/index.md (77%) rename docs/{user_documentation/accounts/change_password.md => user/accounts/password.md} (100%) rename docs/{user_documentation/accounts/check_quota.md => user/accounts/quota.md} (100%) rename docs/{user_documentation/channels/delete_artist.md => user/channels/artist/delete.md} (98%) rename docs/{user_documentation/channels/upload_artist.md => user/channels/artist/upload.md} (97%) rename docs/{user_documentation/channels/create_channel.md => user/channels/create.md} (98%) rename docs/{user_documentation/channels/delete_channel.md => user/channels/delete.md} (100%) rename docs/{user_documentation/channels/edit_channel.md => user/channels/edit.md} (100%) rename docs/{user_documentation/channels/follow_channel.md => user/channels/follow.md} (100%) rename docs/{user_documentation => user}/channels/index.md (84%) rename docs/{user_documentation/channels/delete_podcast.md => user/channels/podcast/delete.md} (98%) rename docs/{user_documentation/channels/upload_podcast.md => user/channels/podcast/upload.md} (97%) rename docs/{user_documentation/channels/subscribe_rss.md => user/channels/rss.md} (100%) rename docs/{user_documentation/favorites/add_favorites.md => user/favorites/add.md} (100%) rename docs/{user_documentation => user}/favorites/index.md (87%) rename docs/{user_documentation/favorites/remove_favorites.md => user/favorites/remove.md} (100%) rename docs/{user_documentation => user}/index.md (100%) rename docs/{user_documentation => user}/info/cli.rst (100%) rename docs/{user_documentation/libraries/delete_content.md => user/libraries/content/delete.md} (100%) rename docs/{user_documentation/libraries/edit_content.md => user/libraries/content/edit.md} (99%) rename docs/{user_documentation/libraries/tag_music.md => user/libraries/content/tag.md} (99%) rename docs/{user_documentation/libraries/upload_content.md => user/libraries/content/upload.md} (87%) rename docs/{user_documentation/libraries/create_library.md => user/libraries/create.md} (100%) rename docs/{user_documentation/libraries/delete_library.md => user/libraries/delete.md} (100%) rename docs/{user_documentation/libraries/edit_library.md => user/libraries/edit.md} (100%) rename docs/{user_documentation/libraries/follow_library.md => user/libraries/follow.md} (100%) rename docs/{user_documentation => user}/libraries/index.md (88%) rename docs/{user_documentation/libraries/share_library.md => user/libraries/share.md} (100%) rename docs/{user_documentation/playlists/add_content.md => user/playlists/content/add.md} (98%) rename docs/{user_documentation/playlists/remove_content.md => user/playlists/content/remove.md} (100%) rename docs/{user_documentation/playlists/reorder_content.md => user/playlists/content/reorder.md} (100%) rename docs/{user_documentation/playlists/create_playlist.md => user/playlists/create.md} (98%) rename docs/{user_documentation/playlists/delete_playlist.md => user/playlists/delete.md} (100%) rename docs/{user_documentation/playlists/edit_playlist.md => user/playlists/edit.md} (100%) rename docs/{user_documentation => user}/playlists/index.md (73%) rename docs/{user_documentation/playlists/listen_playlist.md => user/playlists/listen.md} (99%) rename docs/{user_documentation => user}/plugins/index.md (89%) rename docs/{user_documentation/plugins/listenbrainz_plugin.md => user/plugins/listenbrainz.md} (100%) rename docs/{user_documentation/plugins/maloja_plugin.md => user/plugins/maloja.md} (100%) rename docs/{user_documentation/plugins/scrobbler_plugin.md => user/plugins/scrobbler.md} (97%) rename docs/{user_documentation/queue/add_album.md => user/queue/album.md} (100%) rename docs/{user_documentation/queue/add_artist.md => user/queue/artist.md} (100%) rename docs/{user_documentation => user}/queue/index.md (74%) rename docs/{user_documentation/queue/add_playlist.md => user/queue/playlist.md} (100%) rename docs/{user_documentation/queue/rearrange_content.md => user/queue/rearrange.md} (100%) rename docs/{user_documentation/queue/remove_content.md => user/queue/remove.md} (100%) rename docs/{user_documentation/queue/add_series.md => user/queue/series.md} (100%) rename docs/{user_documentation/queue/add_tracks.md => user/queue/tracks.md} (100%) rename docs/{user_documentation/radios/create_radio.md => user/radios/create.md} (100%) rename docs/{user_documentation/radios/delete_radio.md => user/radios/delete.md} (97%) rename docs/{user_documentation/radios/edit_radio.md => user/radios/edit.md} (100%) rename docs/{user_documentation => user}/radios/index.md (94%) rename docs/{user_documentation/radios/listen_radio.md => user/radios/listen.md} (99%) rename docs/{user_documentation/reports/report_account.md => user/reports/account.md} (100%) rename docs/{user_documentation/reports/report_album.md => user/reports/album.md} (100%) rename docs/{user_documentation/reports/report_artist.md => user/reports/artist.md} (100%) rename docs/{user_documentation/reports/report_channel.md => user/reports/channel.md} (100%) rename docs/{user_documentation => user}/reports/index.md (84%) rename docs/{user_documentation/reports/report_library.md => user/reports/library.md} (100%) rename docs/{user_documentation/reports/report_playlist.md => user/reports/playlist.md} (100%) rename docs/{user_documentation/reports/report_track.md => user/reports/track.md} (100%) rename docs/{user_documentation/subsonic/disable_subsonic.md => user/subsonic/disable.md} (97%) rename docs/{user_documentation => user}/subsonic/index.md (90%) rename docs/{user_documentation/subsonic/subsonic_password.md => user/subsonic/password/request.md} (100%) rename docs/{user_documentation/subsonic/reset_subsonic.md => user/subsonic/password/reset.md} (100%) diff --git a/docs/administrator_documentation/configuration_docs/change_url.md b/docs/administrator/configuration/change_url.md similarity index 97% rename from docs/administrator_documentation/configuration_docs/change_url.md rename to docs/administrator/configuration/change_url.md index 719aa5f3a..b22e13d17 100644 --- a/docs/administrator_documentation/configuration_docs/change_url.md +++ b/docs/administrator/configuration/change_url.md @@ -13,7 +13,7 @@ Your instance URL is your pod's unique identifier in the {term}`fediverse`. If y To clean the database, the `funkwhale-manage` command line interface contains a `fix_federation_ids` command. ```{warning} -Running `fix_federation_ids` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade_docs/backup.md). +Running `fix_federation_ids` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md). ``` ## Update your instance URL diff --git a/docs/administrator_documentation/configuration_docs/env_file.md b/docs/administrator/configuration/env_file.md similarity index 98% rename from docs/administrator_documentation/configuration_docs/env_file.md rename to docs/administrator/configuration/env_file.md index 3b976d81e..0ac82af01 100644 --- a/docs/administrator_documentation/configuration_docs/env_file.md +++ b/docs/administrator/configuration/env_file.md @@ -83,7 +83,7 @@ value: false Whether to enable LDAP authentication. -See {doc}`/administrator_documentation/configuration_docs/ldap` for more information. +See {doc}`/administrator/configuration/ldap` for more information. ``` diff --git a/docs/administrator_documentation/configuration_docs/frontend.md b/docs/administrator/configuration/frontend.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/frontend.md rename to docs/administrator/configuration/frontend.md diff --git a/docs/administrator_documentation/configuration_docs/index.md b/docs/administrator/configuration/index.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/index.md rename to docs/administrator/configuration/index.md diff --git a/docs/administrator_documentation/configuration_docs/instance_settings.md b/docs/administrator/configuration/instance_settings.md similarity index 97% rename from docs/administrator_documentation/configuration_docs/instance_settings.md rename to docs/administrator/configuration/instance_settings.md index be32287c9..51ef4dbda 100644 --- a/docs/administrator_documentation/configuration_docs/instance_settings.md +++ b/docs/administrator/configuration/instance_settings.md @@ -84,7 +84,7 @@ API Requires authentication Controls whether {term}`unauthenticated users ` can access content on your pod. If __enabled__, users need to have an account on your pod to access content. If __disabled__, users without an account can listen to content stored in public libraries. ```{seealso} - {doc}`../../moderator_documentation/content/library_visibility`. + {doc}`../../moderator/content/library`. ``` Default permissions @@ -94,7 +94,7 @@ Upload quota The default upload quota for users in MB. You can override this on a per-user basis. ```{seealso} - {doc}`../../moderator_documentation/reports/handle_users` + {doc}`../../moderator/reports/users` ``` ```` diff --git a/docs/administrator_documentation/configuration_docs/ldap.md b/docs/administrator/configuration/ldap.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/ldap.md rename to docs/administrator/configuration/ldap.md diff --git a/docs/administrator_documentation/configuration_docs/mrf.md b/docs/administrator/configuration/mrf.md similarity index 98% rename from docs/administrator_documentation/configuration_docs/mrf.md rename to docs/administrator/configuration/mrf.md index 5564dba92..6de2e76e8 100644 --- a/docs/administrator_documentation/configuration_docs/mrf.md +++ b/docs/administrator/configuration/mrf.md @@ -1,6 +1,6 @@ # Message Rewrite Facility (MRF) -Funkwhale includes a feature that mimics [Pleroma’s Message Rewrite Facility (MRF)](https://docs-develop.pleroma.social/backend/configuration/mrf/). The MRF enables instance admins to create custom moderation rules. You can use these rules to complement Funkwhale's [built-in moderation tools](../../moderator_documentation/index.md). +Funkwhale includes a feature that mimics [Pleroma’s Message Rewrite Facility (MRF)](https://docs-develop.pleroma.social/backend/configuration/mrf/). The MRF enables instance admins to create custom moderation rules. You can use these rules to complement Funkwhale's [built-in moderation tools](../../moderator/index.md). ## Architecture diff --git a/docs/administrator_documentation/configuration_docs/object_storage.md b/docs/administrator/configuration/object_storage.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/object_storage.md rename to docs/administrator/configuration/object_storage.md diff --git a/docs/administrator_documentation/configuration_docs/optimize.md b/docs/administrator/configuration/optimize.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/optimize.md rename to docs/administrator/configuration/optimize.md diff --git a/docs/administrator_documentation/configuration_docs/rate-limiting.md b/docs/administrator/configuration/rate-limiting.md similarity index 100% rename from docs/administrator_documentation/configuration_docs/rate-limiting.md rename to docs/administrator/configuration/rate-limiting.md diff --git a/docs/administrator_documentation/django/delete_content.md b/docs/administrator/django/delete_content.md similarity index 96% rename from docs/administrator_documentation/django/delete_content.md rename to docs/administrator/django/delete_content.md index e2e06097b..80436540f 100644 --- a/docs/administrator_documentation/django/delete_content.md +++ b/docs/administrator/django/delete_content.md @@ -1,7 +1,7 @@ # Delete content in the Django dashboard ```{note} -Deleting content using the Django dashboard isn't recommended. Use an object's [moderation page](../../moderator_documentation/content/delete_content.md) where possible. +Deleting content using the Django dashboard isn't recommended. Use an object's [moderation page](../../moderator/content/delete.md) where possible. ``` You can delete content from your pod in the Django dashboard. The dashboard gives you access to all data associated with the content. diff --git a/docs/administrator_documentation/django/index.md b/docs/administrator/django/index.md similarity index 100% rename from docs/administrator_documentation/django/index.md rename to docs/administrator/django/index.md diff --git a/docs/administrator_documentation/import_docs/index.md b/docs/administrator/import.md similarity index 95% rename from docs/administrator_documentation/import_docs/index.md rename to docs/administrator/import.md index a1b8bf02d..1ce62dee0 100644 --- a/docs/administrator_documentation/import_docs/index.md +++ b/docs/administrator/import.md @@ -1,6 +1,6 @@ # Import music from your server -You can import music files you have saved on your server. You need to make sure your files have the [required ID3 tags](../../user_documentation/libraries/tag_music.md). We recommend using [Musicbrainz Picard](https://picard.musicbrainz.org/) for tagging. +You can import music files you have saved on your server. You need to make sure your files have the [required ID3 tags](../../user/libraries/content/tag.md). We recommend using [Musicbrainz Picard](https://picard.musicbrainz.org/) for tagging. Funkwhale supports the following import methods: @@ -60,7 +60,7 @@ This downloads a set compressed albums to your `data/music` directory and unzips ## Find your library ID -You need to create a library before you can import music. Follow the instructions in [Create a library](../../user_documentation/libraries/create_library.md) to get started. +You need to create a library before you can import music. Follow the instructions in [Create a library](../../user/libraries/create.md) to get started. Once you've created your library, you can find its ID by following these steps: @@ -164,7 +164,7 @@ To use the in-place import method, follow these steps: cd /srv/funkwhale ``` -2. Add your storage location to your `.env` file if you don't want to link it to the Funkwhale store. See the [in-place import configuration variables](../configuration_docs/env_file.md#in-place-import-configuration) for more information. +2. Add your storage location to your `.env` file if you don't want to link it to the Funkwhale store. See the [in-place import configuration variables](../configuration/env_file.md#in-place-import-configuration) for more information. 3. Export your library ID to reference it later. In this example, the library ID is "769a2bc3". Replace this with your library ID. ```{code-block} sh @@ -184,7 +184,7 @@ Funkwhale imports the music in your storage directory into the specified library :::{tab-item} Docker :sync: docker -1. Add your storage location to your `.env` file if you don't want to bind it to the Funkwhale store. See the [in-place import configuration variables](../configuration_docs/env_file.md#in-place-import-configuration) for more information. +1. Add your storage location to your `.env` file if you don't want to bind it to the Funkwhale store. See the [in-place import configuration variables](../configuration/env_file.md#in-place-import-configuration) for more information. 2. Run your import command against your music storage directory: ```{code-block} sh diff --git a/docs/administrator_documentation/index.md b/docs/administrator/index.md similarity index 52% rename from docs/administrator_documentation/index.md rename to docs/administrator/index.md index 5734f950e..e9aa32613 100644 --- a/docs/administrator_documentation/index.md +++ b/docs/administrator/index.md @@ -8,16 +8,16 @@ Follow the guides in this section to set up and administrate your pod. ## Install Funkwhale on your server -Funkwhale is self-hosted, meaning you run it on your own server. To set up your own Funkwhale pod, check out [our installation guides](installation_docs/index.md). Choose the installation method that works for you! +Funkwhale is self-hosted, meaning you run it on your own server. To set up your own Funkwhale pod, check out [our installation guides](installation/index.md). Choose the installation method that works for you! ## Configure your Funkwhale pod -Once you've installed Funkwhale, you can use [the guides in this section](configuration_docs/index.md) to configure it. +Once you've installed Funkwhale, you can use [the guides in this section](configuration/index.md) to configure it. ## Upgrade your Funkwhale pod -Funkwhale releases new updates regularly. To keep up-to-date with these changes, check out our [upgrade guides](upgrade_docs/index.md). If you're moving from our deprecated mono-container Docker setup, check out our [migration guide](migration_guide/index.md). +Funkwhale releases new updates regularly. To keep up-to-date with these changes, check out our [upgrade guides](upgrade/index.md). If you're moving from our deprecated mono-container Docker setup, check out our [migration guide](migration_guide.md). ## Manage your Funkwhale pod -Funkwhale provides tools for managing content and users on your Funkwhale pod. In addition to the [frontend moderation tools](../moderator_documentation/index.md), pod admins can use some extra tools for more powerful administration. Check out our [guide to the Django dashboard](django/index.md) and our [management script](manage_script/index.md) to get started. +Funkwhale provides tools for managing content and users on your Funkwhale pod. In addition to the [frontend moderation tools](../moderator/index.md), pod admins can use some extra tools for more powerful administration. Check out our [guide to the Django dashboard](django/index.md) and our [management script](manage_script/index.md) to get started. diff --git a/docs/administrator_documentation/installation_docs/debian.md b/docs/administrator/installation/debian.md similarity index 100% rename from docs/administrator_documentation/installation_docs/debian.md rename to docs/administrator/installation/debian.md diff --git a/docs/administrator_documentation/installation_docs/docker.md b/docs/administrator/installation/docker.md similarity index 100% rename from docs/administrator_documentation/installation_docs/docker.md rename to docs/administrator/installation/docker.md diff --git a/docs/administrator_documentation/installation_docs/index.md b/docs/administrator/installation/index.md similarity index 100% rename from docs/administrator_documentation/installation_docs/index.md rename to docs/administrator/installation/index.md diff --git a/docs/administrator_documentation/installation_docs/migrate.md b/docs/administrator/installation/migrate.md similarity index 97% rename from docs/administrator_documentation/installation_docs/migrate.md rename to docs/administrator/installation/migrate.md index f3d343c3b..28860368e 100644 --- a/docs/administrator_documentation/installation_docs/migrate.md +++ b/docs/administrator/installation/migrate.md @@ -14,7 +14,7 @@ Destination server ``` ```{note} -Make sure you [back up your data](../upgrade_docs/backup.md) before proceeding. This ensures you don't lose anything during the migration. +Make sure you [back up your data](../upgrade/backup.md) before proceeding. This ensures you don't lose anything during the migration. ``` ```{contents} diff --git a/docs/administrator_documentation/installation_docs/quick_install.md b/docs/administrator/installation/quick_install.md similarity index 100% rename from docs/administrator_documentation/installation_docs/quick_install.md rename to docs/administrator/installation/quick_install.md diff --git a/docs/administrator_documentation/installation_docs/third_party.md b/docs/administrator/installation/third_party.md similarity index 100% rename from docs/administrator_documentation/installation_docs/third_party.md rename to docs/administrator/installation/third_party.md diff --git a/docs/administrator_documentation/manage_script/create_library.md b/docs/administrator/manage_script/create_library.md similarity index 69% rename from docs/administrator_documentation/manage_script/create_library.md rename to docs/administrator/manage_script/create_library.md index ccabf49b9..e76ee313f 100644 --- a/docs/administrator_documentation/manage_script/create_library.md +++ b/docs/administrator/manage_script/create_library.md @@ -1,6 +1,6 @@ # Create a library -Use the `create_library` command to create new libraries for a given user. +Use the `create` command to create new libraries for a given user. ```{list-table} :header-rows: 1 @@ -19,7 +19,7 @@ Use the `create_library` command to create new libraries for a given user. * - `--privacy-level` - Enum (String) - - The [privacy level](../../user_documentation/libraries/create_library.md) of the library + - The [privacy level](../../user/libraries/create.md) of the library - `"me"` (default) - `"instance"` - `"everyone"` @@ -38,7 +38,7 @@ Use the following command to create a new library with a custom name and privacy :sync: debian ```{code-block} sh -venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone" +venv/bin/funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone" ``` ::: @@ -47,7 +47,7 @@ venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy- :sync: docker ```{code-block} sh -sudo docker compose run --rm api funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone" +sudo docker compose run --rm api funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone" ``` ::: @@ -70,7 +70,7 @@ You can create a library using only a username. The script substitutes default v :sync: debian ```{code-block} sh -venv/bin/funkwhale-manage create_library username1 +venv/bin/funkwhale-manage create username1 ``` ::: @@ -79,7 +79,7 @@ venv/bin/funkwhale-manage create_library username1 :sync: docker ```{code-block} sh -sudo docker compose run --rm api funkwhale-manage create_library username1 +sudo docker compose run --rm api funkwhale-manage create username1 ``` ::: @@ -102,7 +102,7 @@ If a library with the same name already exists for the given user, the script wi :sync: debian ```{code-block} sh -venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone" +venv/bin/funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone" ``` ::: @@ -111,7 +111,7 @@ venv/bin/funkwhale-manage create_library username1 --name="Library 1" --privacy- :sync: docker ```{code-block} sh -sudo docker compose run --rm api funkwhale-manage create_library username1 --name="Library 1" --privacy-level="everyone" +sudo docker compose run --rm api funkwhale-manage create username1 --name="Library 1" --privacy-level="everyone" ``` ::: diff --git a/docs/administrator_documentation/manage_script/database.md b/docs/administrator/manage_script/database.md similarity index 93% rename from docs/administrator_documentation/manage_script/database.md rename to docs/administrator/manage_script/database.md index 531271d82..1e938f5ae 100644 --- a/docs/administrator_documentation/manage_script/database.md +++ b/docs/administrator/manage_script/database.md @@ -5,7 +5,7 @@ Funkwhale keeps references to files imported using the in-place method. If you m Use the `check_inplace_files` command to check the database for invalid references. This command loops through all in-place imports and checks if the file is accessible. If the file isn't accessible, the command deletes the database object. ```{warning} -Running `check_inplace_files` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade_docs/backup.md). +Running `check_inplace_files` with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md). ``` To ensure you don't remove data by accident, this command runs in dry run mode by default. In dry run mode, the command lists the items it will delete. Run the command with the `--no-dry-run` flag to perform the pruning action. diff --git a/docs/administrator_documentation/manage_script/fix_uploads.md b/docs/administrator/manage_script/fix_uploads.md similarity index 100% rename from docs/administrator_documentation/manage_script/fix_uploads.md rename to docs/administrator/manage_script/fix_uploads.md diff --git a/docs/administrator_documentation/manage_script/index.md b/docs/administrator/manage_script/index.md similarity index 100% rename from docs/administrator_documentation/manage_script/index.md rename to docs/administrator/manage_script/index.md diff --git a/docs/administrator_documentation/manage_script/library.md b/docs/administrator/manage_script/library.md similarity index 97% rename from docs/administrator_documentation/manage_script/library.md rename to docs/administrator/manage_script/library.md index 44ff9fbd2..52f701e1c 100644 --- a/docs/administrator_documentation/manage_script/library.md +++ b/docs/administrator/manage_script/library.md @@ -7,7 +7,7 @@ Sometimes you may want to clear out dangling metadata. For example, if you impor To help with this, the `funkwhale-manage` command line interface includes commands to prune dangling metadata from your database. All prune commands are available under the `funkwhale-manage prune_library` namespace. To ensure you don't remove data by accident, all commands run in dry run mode by default. Run commands with the `--no-dry-run` flag to perform the pruning action. ```{warning} -Running `prune_library` commands with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade_docs/backup.md). +Running `prune_library` commands with the `--no-dry-run` flag is irreversible. Make sure you [back up your data](../upgrade/backup.md). ``` ## Commands diff --git a/docs/administrator_documentation/manage_script/tags.md b/docs/administrator/manage_script/tags.md similarity index 100% rename from docs/administrator_documentation/manage_script/tags.md rename to docs/administrator/manage_script/tags.md diff --git a/docs/administrator_documentation/manage_script/thumbnails.md b/docs/administrator/manage_script/thumbnails.md similarity index 100% rename from docs/administrator_documentation/manage_script/thumbnails.md rename to docs/administrator/manage_script/thumbnails.md diff --git a/docs/administrator_documentation/manage_script/users.md b/docs/administrator/manage_script/users.md similarity index 100% rename from docs/administrator_documentation/manage_script/users.md rename to docs/administrator/manage_script/users.md diff --git a/docs/administrator_documentation/migration_guide/index.md b/docs/administrator/migration_guide.md similarity index 100% rename from docs/administrator_documentation/migration_guide/index.md rename to docs/administrator/migration_guide.md diff --git a/docs/administrator_documentation/troubleshooting/backend.md b/docs/administrator/troubleshooting/backend.md similarity index 97% rename from docs/administrator_documentation/troubleshooting/backend.md rename to docs/administrator/troubleshooting/backend.md index 130eff622..53a3a1dd3 100644 --- a/docs/administrator_documentation/troubleshooting/backend.md +++ b/docs/administrator/troubleshooting/backend.md @@ -106,7 +106,7 @@ If you're having issues importing files, try the following: ::: - Make sure your files play in another media player. -- Make sure your files are [tagged correctly](../../user_documentation/libraries/tag_music.md). +- Make sure your files are [tagged correctly](../../user/libraries/content/tag.md). - Check the Celery logs for errors during the import. ### Federation issues diff --git a/docs/administrator_documentation/troubleshooting/frontend.md b/docs/administrator/troubleshooting/frontend.md similarity index 100% rename from docs/administrator_documentation/troubleshooting/frontend.md rename to docs/administrator/troubleshooting/frontend.md diff --git a/docs/administrator_documentation/troubleshooting/get_help.md b/docs/administrator/troubleshooting/get_help.md similarity index 100% rename from docs/administrator_documentation/troubleshooting/get_help.md rename to docs/administrator/troubleshooting/get_help.md diff --git a/docs/administrator_documentation/troubleshooting/index.md b/docs/administrator/troubleshooting/index.md similarity index 100% rename from docs/administrator_documentation/troubleshooting/index.md rename to docs/administrator/troubleshooting/index.md diff --git a/docs/administrator_documentation/uninstall_docs/debian.md b/docs/administrator/uninstall/debian.md similarity index 95% rename from docs/administrator_documentation/uninstall_docs/debian.md rename to docs/administrator/uninstall/debian.md index 1f7c1042e..2500cecdf 100644 --- a/docs/administrator_documentation/uninstall_docs/debian.md +++ b/docs/administrator/uninstall/debian.md @@ -3,7 +3,7 @@ To uninstall Funkwhale from your Debian server, follow the instructions in this guide. ```{warning} -Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade_docs/backup.md). +Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade/backup.md). ``` ```{contents} @@ -92,7 +92,7 @@ To stop serving Funkwhale from your web server, you need to remove your reverse ## Remove the Funkwhale database ```{warning} -This action is __irreversible__. Make sure you have [backed up your data](../upgrade_docs/backup.md) before proceeding. +This action is __irreversible__. Make sure you have [backed up your data](../upgrade/backup.md) before proceeding. ``` Once you have stopped the Funkwhale services, you can remove the Funkwhale database. @@ -118,7 +118,7 @@ Once you have stopped the Funkwhale services, you can remove the Funkwhale datab ## Delete the Funkwhale account ```{warning} -This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade_docs/backup.md) you want to keep. +This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade/backup.md) you want to keep. ``` Once you have removed the database, you can delete the `funkwhale` user and all associated data. diff --git a/docs/administrator_documentation/uninstall_docs/docker.md b/docs/administrator/uninstall/docker.md similarity index 95% rename from docs/administrator_documentation/uninstall_docs/docker.md rename to docs/administrator/uninstall/docker.md index 7453b7899..dd63141e9 100644 --- a/docs/administrator_documentation/uninstall_docs/docker.md +++ b/docs/administrator/uninstall/docker.md @@ -3,7 +3,7 @@ To uninstall a Docker-based Funkwhale installation from your server, follow the instructions in this guide. ```{warning} -Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade_docs/backup.md). +Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade/backup.md). ``` ```{contents} @@ -74,7 +74,7 @@ To stop serving Funkwhale from your web server, you need to remove your reverse ## Remove the containers and their volumes ```{warning} -This action is __irreversible__. Make sure you have [backed up your data](../upgrade_docs/backup.md) before proceeding. +This action is __irreversible__. Make sure you have [backed up your data](../upgrade/backup.md) before proceeding. ``` Once you have stopped the containers, you can delete all containers and associated volumes. diff --git a/docs/administrator_documentation/uninstall_docs/index.md b/docs/administrator/uninstall/index.md similarity index 100% rename from docs/administrator_documentation/uninstall_docs/index.md rename to docs/administrator/uninstall/index.md diff --git a/docs/administrator_documentation/uninstall_docs/quick_install.md b/docs/administrator/uninstall/quick_install.md similarity index 95% rename from docs/administrator_documentation/uninstall_docs/quick_install.md rename to docs/administrator/uninstall/quick_install.md index d11ad91b8..8c5a455c0 100644 --- a/docs/administrator_documentation/uninstall_docs/quick_install.md +++ b/docs/administrator/uninstall/quick_install.md @@ -3,7 +3,7 @@ The Funkwhale quick install script doesn't currently offer an uninstall command. This is because you may be using its dependencies for other software. To uninstall a quick install Funkwhale installation, follow the instructions in this guide. ```{warning} -Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade_docs/backup.md). +Removing Funkwhale data is __irreversible__. Make sure you [back up your data](../upgrade/backup.md). ``` ```{contents} @@ -92,7 +92,7 @@ To stop serving Funkwhale from your web server, you need to remove your reverse ## Remove the Funkwhale database ```{warning} -This action is __irreversible__. Make sure you have [backed up your data](../upgrade_docs/backup.md) before proceeding. +This action is __irreversible__. Make sure you have [backed up your data](../upgrade/backup.md) before proceeding. ``` Once you have stopped the Funkwhale services, you can remove the Funkwhale database. @@ -118,7 +118,7 @@ Once you have stopped the Funkwhale services, you can remove the Funkwhale datab ## Delete the Funkwhale account ```{warning} -This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade_docs/backup.md) you want to keep. +This action deletes the `/srv/funkwhale/` directory. Make sure you have [backed up any data](../upgrade/backup.md) you want to keep. ``` Once you have removed the database, you can delete the `funkwhale` user and all associated data. diff --git a/docs/administrator_documentation/upgrade_docs/backup.md b/docs/administrator/upgrade/backup.md similarity index 100% rename from docs/administrator_documentation/upgrade_docs/backup.md rename to docs/administrator/upgrade/backup.md diff --git a/docs/administrator_documentation/upgrade_docs/debian.md b/docs/administrator/upgrade/debian.md similarity index 81% rename from docs/administrator_documentation/upgrade_docs/debian.md rename to docs/administrator/upgrade/debian.md index 40d6b40d0..b7e14c745 100644 --- a/docs/administrator_documentation/upgrade_docs/debian.md +++ b/docs/administrator/upgrade/debian.md @@ -1,6 +1,6 @@ # Upgrade your Debian Funkwhale installation -If you installed Funkwhale following the [Debian guide](../installation_docs/debian.md), follow these steps to upgrade. +If you installed Funkwhale following the [Debian guide](../installation/debian.md), follow these steps to upgrade. ## Cleanup old funkwhale files @@ -30,9 +30,9 @@ If you installed Funkwhale following the [Debian guide](../installation_docs/deb export FUNKWHALE_VERSION={sub-ref}`version` ``` -2. Follow the [Download Funkwhale](../installation_docs/debian.md#3-download-funkwhale) instructions in the installation guide. +2. Follow the [Download Funkwhale](../installation/debian.md#3-download-funkwhale) instructions in the installation guide. -3. Follow the [Install the Funkwhale API](../installation_docs/debian.md#4-install-the-funkwhale-api) instructions in the installation guide. +3. Follow the [Install the Funkwhale API](../installation/debian.md#4-install-the-funkwhale-api) instructions in the installation guide. ## Update your Funkwhale instance diff --git a/docs/administrator_documentation/upgrade_docs/docker.md b/docs/administrator/upgrade/docker.md similarity index 98% rename from docs/administrator_documentation/upgrade_docs/docker.md rename to docs/administrator/upgrade/docker.md index c15a2bc8b..aa6954982 100644 --- a/docs/administrator_documentation/upgrade_docs/docker.md +++ b/docs/administrator/upgrade/docker.md @@ -1,6 +1,6 @@ # Upgrade your Docker Funkwhale installation -If you installed Funkwhale following the [Docker guide](../installation_docs/docker.md), follow these steps to upgrade. +If you installed Funkwhale following the [Docker guide](../installation/docker.md), follow these steps to upgrade. ## Upgrade Funkwhale diff --git a/docs/administrator_documentation/upgrade_docs/index.md b/docs/administrator/upgrade/index.md similarity index 100% rename from docs/administrator_documentation/upgrade_docs/index.md rename to docs/administrator/upgrade/index.md diff --git a/docs/administrator_documentation/upgrade_docs/quick_install.md b/docs/administrator/upgrade/quick_install.md similarity index 66% rename from docs/administrator_documentation/upgrade_docs/quick_install.md rename to docs/administrator/upgrade/quick_install.md index f6299561a..6eb20b81b 100644 --- a/docs/administrator_documentation/upgrade_docs/quick_install.md +++ b/docs/administrator/upgrade/quick_install.md @@ -1,6 +1,6 @@ # Upgrade using the quick install script -If you installed Funkwhale using the [quick install script](../installation_docs/quick_install.md), upgrading your instance is as simple as running the following command on your server: +If you installed Funkwhale using the [quick install script](../installation/quick_install.md), upgrading your instance is as simple as running the following command on your server: ```bash sudo sh -c "$(curl -sSL https://get.funkwhale.audio/upgrade.sh)". diff --git a/docs/contributor_documentation/documentation.md b/docs/contributor/documentation.md similarity index 98% rename from docs/contributor_documentation/documentation.md rename to docs/contributor/documentation.md index 7589d786e..16c4b3f22 100644 --- a/docs/contributor_documentation/documentation.md +++ b/docs/contributor/documentation.md @@ -89,7 +89,7 @@ Here's an example of the typical workflow for creating documentation: 3. Make your changes and verify them by running the [Docker container](#local-setup) 4. Add [redirects](#redirects) if required -5. Add a [changelog fragment](../developer_documentation/workflows/changelog.md) +5. Add a [changelog fragment](../developer/workflows/changelog.md) 6. Add your changed files to a commit ```{code-block} sh diff --git a/docs/contributor_documentation/index.md b/docs/contributor/index.md similarity index 92% rename from docs/contributor_documentation/index.md rename to docs/contributor/index.md index 58f51eacc..6ac84dae8 100644 --- a/docs/contributor_documentation/index.md +++ b/docs/contributor/index.md @@ -1,7 +1,7 @@ # Get started ```{note} -Are you a software developer? Check out our [developer documentation](../developer_documentation/index.md) to contribute to our codebase. +Are you a software developer? Check out our [developer documentation](../developer/index.md) to contribute to our codebase. ``` Funkwhale is a community-led software project, so we depend on our community donating their time and skills. Whether you're experienced in a specific field or just starting out, we welcome any contributions and will support you with any task you take on. diff --git a/docs/contributor_documentation/translation.md b/docs/contributor/translation.md similarity index 100% rename from docs/contributor_documentation/translation.md rename to docs/contributor/translation.md diff --git a/docs/developer_documentation/api/authentication.md b/docs/developer/api/authentication.md similarity index 100% rename from docs/developer_documentation/api/authentication.md rename to docs/developer/api/authentication.md diff --git a/docs/developer_documentation/api/index.md b/docs/developer/api/index.md similarity index 100% rename from docs/developer_documentation/api/index.md rename to docs/developer/api/index.md diff --git a/docs/developer_documentation/api/rate_limit.md b/docs/developer/api/rate_limit.md similarity index 100% rename from docs/developer_documentation/api/rate_limit.md rename to docs/developer/api/rate_limit.md diff --git a/docs/developer_documentation/api/subsonic.md b/docs/developer/api/subsonic.md similarity index 100% rename from docs/developer_documentation/api/subsonic.md rename to docs/developer/api/subsonic.md diff --git a/docs/developer_documentation/architecture.md b/docs/developer/architecture.md similarity index 100% rename from docs/developer_documentation/architecture.md rename to docs/developer/architecture.md diff --git a/docs/developer_documentation/contribute/api.md b/docs/developer/contribute/api.md similarity index 100% rename from docs/developer_documentation/contribute/api.md rename to docs/developer/contribute/api.md diff --git a/docs/developer_documentation/contribute/copy.md b/docs/developer/contribute/copy.md similarity index 100% rename from docs/developer_documentation/contribute/copy.md rename to docs/developer/contribute/copy.md diff --git a/docs/developer_documentation/contribute/frontend.md b/docs/developer/contribute/frontend.md similarity index 100% rename from docs/developer_documentation/contribute/frontend.md rename to docs/developer/contribute/frontend.md diff --git a/docs/developer_documentation/contribute/index.md b/docs/developer/contribute/index.md similarity index 100% rename from docs/developer_documentation/contribute/index.md rename to docs/developer/contribute/index.md diff --git a/docs/developer_documentation/federation/index.md b/docs/developer/federation/index.md similarity index 100% rename from docs/developer_documentation/federation/index.md rename to docs/developer/federation/index.md diff --git a/docs/developer_documentation/index.md b/docs/developer/index.md similarity index 100% rename from docs/developer_documentation/index.md rename to docs/developer/index.md diff --git a/docs/developer_documentation/plugins/create.md b/docs/developer/plugins/create.md similarity index 100% rename from docs/developer_documentation/plugins/create.md rename to docs/developer/plugins/create.md diff --git a/docs/developer_documentation/plugins/index.md b/docs/developer/plugins/index.md similarity index 100% rename from docs/developer_documentation/plugins/index.md rename to docs/developer/plugins/index.md diff --git a/docs/developer_documentation/plugins/install.md b/docs/developer/plugins/install.md similarity index 100% rename from docs/developer_documentation/plugins/install.md rename to docs/developer/plugins/install.md diff --git a/docs/developer_documentation/setup/docker.md b/docs/developer/setup/docker.md similarity index 100% rename from docs/developer_documentation/setup/docker.md rename to docs/developer/setup/docker.md diff --git a/docs/developer_documentation/setup/gitpod-select-gitpod-in-gitlab.png b/docs/developer/setup/gitpod-select-gitpod-in-gitlab.png similarity index 100% rename from docs/developer_documentation/setup/gitpod-select-gitpod-in-gitlab.png rename to docs/developer/setup/gitpod-select-gitpod-in-gitlab.png diff --git a/docs/developer_documentation/setup/gitpod.md b/docs/developer/setup/gitpod.md similarity index 100% rename from docs/developer_documentation/setup/gitpod.md rename to docs/developer/setup/gitpod.md diff --git a/docs/developer_documentation/setup/index.md b/docs/developer/setup/index.md similarity index 100% rename from docs/developer_documentation/setup/index.md rename to docs/developer/setup/index.md diff --git a/docs/developer_documentation/setup/vite.md b/docs/developer/setup/vite.md similarity index 100% rename from docs/developer_documentation/setup/vite.md rename to docs/developer/setup/vite.md diff --git a/docs/developer_documentation/workflows/changelog.md b/docs/developer/workflows/changelog.md similarity index 100% rename from docs/developer_documentation/workflows/changelog.md rename to docs/developer/workflows/changelog.md diff --git a/docs/developer_documentation/workflows/git.md b/docs/developer/workflows/git.md similarity index 100% rename from docs/developer_documentation/workflows/git.md rename to docs/developer/workflows/git.md diff --git a/docs/developer_documentation/workflows/index.md b/docs/developer/workflows/index.md similarity index 100% rename from docs/developer_documentation/workflows/index.md rename to docs/developer/workflows/index.md diff --git a/docs/developer_documentation/workflows/pre-commit.md b/docs/developer/workflows/pre-commit.md similarity index 100% rename from docs/developer_documentation/workflows/pre-commit.md rename to docs/developer/workflows/pre-commit.md diff --git a/docs/developer_documentation/workflows/release.md b/docs/developer/workflows/release.md similarity index 100% rename from docs/developer_documentation/workflows/release.md rename to docs/developer/workflows/release.md diff --git a/docs/index.md b/docs/index.md index 76c7dfc02..e67c3a2e6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,18 +11,18 @@ hidden: true caption: User documentation --- -user_documentation/index -user_documentation/accounts/index -user_documentation/channels/index -user_documentation/libraries/index -user_documentation/queue/index -user_documentation/playlists/index -user_documentation/radios/index -user_documentation/favorites/index -user_documentation/reports/index -user_documentation/subsonic/index -user_documentation/plugins/index -user_documentation/info/cli +user/index +user/accounts/index +user/channels/index +user/libraries/index +user/queue/index +user/playlists/index +user/radios/index +user/favorites/index +user/reports/index +user/subsonic/index +user/plugins/index +user/info/cli ``` @@ -33,16 +33,16 @@ caption: Admin documentation hidden: true --- -administrator_documentation/index -administrator_documentation/installation_docs/index -administrator_documentation/configuration_docs/index -administrator_documentation/import_docs/index -administrator_documentation/upgrade_docs/index -administrator_documentation/migration_guide/index -administrator_documentation/django/index -administrator_documentation/manage_script/index -administrator_documentation/uninstall_docs/index -administrator_documentation/troubleshooting/index +administrator/index +administrator/installation/index +administrator/configuration/index +administrator/import +administrator/upgrade/index +administrator/migration_guide +administrator/django/index +administrator/manage_script/index +administrator/uninstall/index +administrator/troubleshooting/index ``` @@ -53,13 +53,13 @@ caption: Moderator documentation hidden: true --- -moderator_documentation/index -moderator_documentation/reports/index -moderator_documentation/internal_users/index -moderator_documentation/content/index -moderator_documentation/domains/index -moderator_documentation/external_users/index -moderator_documentation/allow_listing/index +moderator/index +moderator/reports/index +moderator/internal_users/index +moderator/content/index +moderator/domains/index +moderator/external_users/index +moderator/allow_listing/index ``` @@ -70,14 +70,14 @@ caption: Developer documentation hidden: true --- -developer_documentation/index -developer_documentation/architecture -developer_documentation/setup/index -developer_documentation/contribute/index -developer_documentation/workflows/index -developer_documentation/api/index -developer_documentation/federation/index -developer_documentation/plugins/index +developer/index +developer/architecture +developer/setup/index +developer/contribute/index +developer/workflows/index +developer/api/index +developer/federation/index +developer/plugins/index ``` @@ -88,9 +88,9 @@ caption: Contributor documentation hidden: true --- -contributor_documentation/index -contributor_documentation/documentation -contributor_documentation/translation +contributor/index +contributor/documentation +contributor/translation ``` @@ -128,7 +128,7 @@ Looking to use Funkwhale for your content? Read through our guides to master the +++ -```{button-link} user_documentation/index.html +```{button-link} user/index.html :ref-type: myst :color: primary :outline: @@ -149,7 +149,7 @@ Want to host your own Funkwhale pod? Our admin documentation guides you through +++ -```{button-link} administrator_documentation/index.html +```{button-link} administrator/index.html :ref-type: ref :color: primary :outline: @@ -170,7 +170,7 @@ Keeping your users safe from harassment and spam or clearing illegal content? Ch +++ -```{button-link} moderator_documentation/index.html +```{button-link} moderator/index.html :ref-type: ref :color: primary :outline: @@ -191,7 +191,7 @@ Want to use Funkwhale's API or help with the project? Our developer docs give yo +++ -```{button-link} developer_documentation/index.html +```{button-link} developer/index.html :ref-type: ref :color: primary :outline: @@ -216,7 +216,7 @@ Want to help make Funkwhale even better? Check out these guides for some ideas. +++ -```{button-link} contributor_documentation/index.html +```{button-link} contributor/index.html :ref-type: ref :color: primary :outline: diff --git a/docs/moderator_documentation/allow_listing/add_domain.md b/docs/moderator/allow_listing/add.md similarity index 100% rename from docs/moderator_documentation/allow_listing/add_domain.md rename to docs/moderator/allow_listing/add.md diff --git a/docs/moderator_documentation/allow_listing/index.md b/docs/moderator/allow_listing/index.md similarity index 85% rename from docs/moderator_documentation/allow_listing/index.md rename to docs/moderator/allow_listing/index.md index 085563c5d..9b34187d9 100644 --- a/docs/moderator_documentation/allow_listing/index.md +++ b/docs/moderator/allow_listing/index.md @@ -2,7 +2,7 @@ By default, Funkwhale communicates with all reachable pods on the {term}`Fediverse`. If you want to lock down which pods you interact with, your pod admin can enable **allow-listing**. With this enabled, only pods on your allow-list can interact with your pod. -If you didn't use allow-listing before, you can remove all content from pods not on your list. Check out our guide on [purging content](../domains/purge_domain.md) to remove this content. +If you didn't use allow-listing before, you can remove all content from pods not on your list. Check out our guide on [purging content](../domains/purge.md) to remove this content. ```{toctree} --- @@ -10,7 +10,7 @@ caption: Manage your pod's allow-list maxdepth: 1 --- -add_domain -remove_domain +add +remove ``` diff --git a/docs/moderator_documentation/allow_listing/remove_domain.md b/docs/moderator/allow_listing/remove.md similarity index 100% rename from docs/moderator_documentation/allow_listing/remove_domain.md rename to docs/moderator/allow_listing/remove.md diff --git a/docs/moderator_documentation/content/delete_content.md b/docs/moderator/content/delete.md similarity index 100% rename from docs/moderator_documentation/content/delete_content.md rename to docs/moderator/content/delete.md diff --git a/docs/moderator_documentation/content/handle_edits.md b/docs/moderator/content/edits.md similarity index 100% rename from docs/moderator_documentation/content/handle_edits.md rename to docs/moderator/content/edits.md diff --git a/docs/moderator_documentation/content/index.md b/docs/moderator/content/index.md similarity index 84% rename from docs/moderator_documentation/content/index.md rename to docs/moderator/content/index.md index ad1a63b26..2185001f0 100644 --- a/docs/moderator_documentation/content/index.md +++ b/docs/moderator/content/index.md @@ -8,8 +8,8 @@ caption: Manage your pod's content maxdepth: 1 --- -handle_edits -library_visibility -delete_content +edits +library +delete ``` diff --git a/docs/moderator_documentation/content/library_visibility.md b/docs/moderator/content/library.md similarity index 100% rename from docs/moderator_documentation/content/library_visibility.md rename to docs/moderator/content/library.md diff --git a/docs/moderator_documentation/domains/add_domain.md b/docs/moderator/domains/add.md similarity index 96% rename from docs/moderator_documentation/domains/add_domain.md rename to docs/moderator/domains/add.md index 3b3943464..09db44ecb 100644 --- a/docs/moderator_documentation/domains/add_domain.md +++ b/docs/moderator/domains/add.md @@ -1,6 +1,6 @@ # 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_rule.md) to it. +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](rules/add.md) to it. :::{dropdown} Required permissions :icon: key diff --git a/docs/moderator_documentation/domains/index.md b/docs/moderator/domains/index.md similarity index 86% rename from docs/moderator_documentation/domains/index.md rename to docs/moderator/domains/index.md index 5798ea565..a7d374e06 100644 --- a/docs/moderator_documentation/domains/index.md +++ b/docs/moderator/domains/index.md @@ -8,8 +8,8 @@ caption: Manage external domains maxdepth: 1 --- -add_domain -purge_domain +add +purge ``` @@ -19,8 +19,8 @@ caption: Manage moderation rules maxdepth: 1 --- -add_rule -edit_rule -delete_rule +rules/add +rules/edit +rules/delete ``` diff --git a/docs/moderator_documentation/domains/purge_domain.md b/docs/moderator/domains/purge.md similarity index 100% rename from docs/moderator_documentation/domains/purge_domain.md rename to docs/moderator/domains/purge.md diff --git a/docs/moderator_documentation/domains/add_rule.md b/docs/moderator/domains/rules/add.md similarity index 100% rename from docs/moderator_documentation/domains/add_rule.md rename to docs/moderator/domains/rules/add.md diff --git a/docs/moderator_documentation/domains/delete_rule.md b/docs/moderator/domains/rules/delete.md similarity index 100% rename from docs/moderator_documentation/domains/delete_rule.md rename to docs/moderator/domains/rules/delete.md diff --git a/docs/moderator_documentation/domains/edit_rule.md b/docs/moderator/domains/rules/edit.md similarity index 100% rename from docs/moderator_documentation/domains/edit_rule.md rename to docs/moderator/domains/rules/edit.md diff --git a/docs/moderator_documentation/external_users/index.md b/docs/moderator/external_users/index.md similarity index 89% rename from docs/moderator_documentation/external_users/index.md rename to docs/moderator/external_users/index.md index 716c2ccad..8a32e21b6 100644 --- a/docs/moderator_documentation/external_users/index.md +++ b/docs/moderator/external_users/index.md @@ -8,7 +8,7 @@ caption: Manage external users maxdepth: 1 --- -purge_users +purge ``` @@ -18,8 +18,8 @@ caption: Manage moderation rules maxdepth: 1 --- -add_rule -edit_rule -delete_rule +rules/add +rules/edit +rules/delete ``` diff --git a/docs/moderator_documentation/external_users/purge_users.md b/docs/moderator/external_users/purge.md similarity index 100% rename from docs/moderator_documentation/external_users/purge_users.md rename to docs/moderator/external_users/purge.md diff --git a/docs/moderator_documentation/external_users/add_rule.md b/docs/moderator/external_users/rules/add.md similarity index 100% rename from docs/moderator_documentation/external_users/add_rule.md rename to docs/moderator/external_users/rules/add.md diff --git a/docs/moderator_documentation/external_users/delete_rule.md b/docs/moderator/external_users/rules/delete.md similarity index 100% rename from docs/moderator_documentation/external_users/delete_rule.md rename to docs/moderator/external_users/rules/delete.md diff --git a/docs/moderator_documentation/external_users/edit_rule.md b/docs/moderator/external_users/rules/edit.md similarity index 100% rename from docs/moderator_documentation/external_users/edit_rule.md rename to docs/moderator/external_users/rules/edit.md diff --git a/docs/moderator_documentation/index.md b/docs/moderator/index.md similarity index 100% rename from docs/moderator_documentation/index.md rename to docs/moderator/index.md diff --git a/docs/moderator_documentation/internal_users/index.md b/docs/moderator/internal_users/index.md similarity index 90% rename from docs/moderator_documentation/internal_users/index.md rename to docs/moderator/internal_users/index.md index 84926821a..f378e9783 100644 --- a/docs/moderator_documentation/internal_users/index.md +++ b/docs/moderator/internal_users/index.md @@ -10,7 +10,7 @@ caption: Moderate users maxdepth: 1 --- -../reports/handle_users.md +../reports/users.md ``` @@ -20,6 +20,6 @@ caption: Handle user registrations maxdepth: 1 --- -handle_registration +registration ``` diff --git a/docs/moderator_documentation/internal_users/handle_registration.md b/docs/moderator/internal_users/registration.md similarity index 100% rename from docs/moderator_documentation/internal_users/handle_registration.md rename to docs/moderator/internal_users/registration.md diff --git a/docs/moderator_documentation/reports/handle_content.md b/docs/moderator/reports/content.md similarity index 90% rename from docs/moderator_documentation/reports/handle_content.md rename to docs/moderator/reports/content.md index 784a0871f..43fb3d250 100644 --- a/docs/moderator_documentation/reports/handle_content.md +++ b/docs/moderator/reports/content.md @@ -30,7 +30,7 @@ To handle a content report from the {guilabel}`Reports` page: 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. Select an action from the {guilabel}`Actions` section: - {guilabel}`Resolve` – resolve the report with no further action. - {guilabel}`Delete reported object` – delete the object associated with the report. If you delete an artist or album, this deletes all files associated with the object. @@ -43,7 +43,7 @@ To handle a content report from the {guilabel}`Reports` page: 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. Select an action from the {guilabel}`Actions` section: - {guilabel}`Resolve` – resolve the report with no further action. - {guilabel}`Delete reported object` – delete the object associated with the report. If you delete an artist or album, this deletes all files associated with the object. @@ -51,7 +51,7 @@ To handle a content report from the {guilabel}`Reports` page: ::: :::: -Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes. +Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](notes.md) to keep a record of your changes. ## Edit content in the moderation page @@ -65,7 +65,7 @@ If you want to edit an object to change its metadata: 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. Select {guilabel}`Open in moderation interface` in the {guilabel}`Reported object` section. The object's moderation page opens. 6. Select {guilabel}`Edit`. The {guilabel}`Edit` page opens. 7. Edit the details on this page. Leave a {guilabel}`Summary` of your changes for reference. @@ -82,7 +82,7 @@ If you want to edit an object to change its metadata: 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. Select {guilabel}`Open in moderation interface` in the {guilabel}`Reported object` section. The object's moderation page opens. 6. Select {guilabel}`Edit`. The {guilabel}`Edit` page opens. 7. Edit the details on this page. Leave a {guilabel}`Summary` of your changes for reference. @@ -94,4 +94,4 @@ If you want to edit an object to change its metadata: ::: :::: -Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes. +Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](notes.md) to keep a record of your changes. diff --git a/docs/moderator_documentation/reports/index.md b/docs/moderator/reports/index.md similarity index 93% rename from docs/moderator_documentation/reports/index.md rename to docs/moderator/reports/index.md index 5861875c9..847e45bdc 100644 --- a/docs/moderator_documentation/reports/index.md +++ b/docs/moderator/reports/index.md @@ -23,9 +23,9 @@ caption: Use the reports page maxdepth: 1 --- -view_reports -search_reports -internal_notes +view +search +notes ``` @@ -35,7 +35,7 @@ caption: Handle reports maxdepth: 1 --- -handle_content -handle_users +content +users ``` diff --git a/docs/moderator_documentation/reports/internal_notes.md b/docs/moderator/reports/notes.md similarity index 93% rename from docs/moderator_documentation/reports/internal_notes.md rename to docs/moderator/reports/notes.md index 89cfe1772..56b6e3bbf 100644 --- a/docs/moderator_documentation/reports/internal_notes.md +++ b/docs/moderator/reports/notes.md @@ -21,7 +21,7 @@ You can add notes to **Unresolved** and **Resolved** reports. To add an internal 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. {guilabel}`Write` your note in the {guilabel}`Internal notes` section. This input field supports Markdown syntax. You can {guilabel}`Preview` how the note will look to other users. 6. Select {guilabel}`Add note` to save your note. @@ -33,7 +33,7 @@ You can add notes to **Unresolved** and **Resolved** reports. To add an internal 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. {guilabel}`Write` your note in the {guilabel}`Internal notes` section. This input field supports Markdown syntax. You can {guilabel}`Preview` how the note will look to other users. 6. Select {guilabel}`Add note` to save your note. @@ -56,7 +56,7 @@ You can delete your own notes and the notes of other moderators. You can do this 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. Find the note you want to delete in the {guilabel}`Internal notes` section. 6. Select {guilabel}`Delete` @@ -68,7 +68,7 @@ You can delete your own notes and the notes of other moderators. You can do this 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. [Search for the report](search_reports.md). +4. [Search for the report](search.md). 5. Find the note you want to delete in the {guilabel}`Internal notes` section. 6. Select {guilabel}`Delete` diff --git a/docs/moderator_documentation/reports/search_reports.md b/docs/moderator/reports/search.md similarity index 93% rename from docs/moderator_documentation/reports/search_reports.md rename to docs/moderator/reports/search.md index c28642386..1def168bb 100644 --- a/docs/moderator_documentation/reports/search_reports.md +++ b/docs/moderator/reports/search.md @@ -42,4 +42,4 @@ The {guilabel}`Reports` page contains filters that enable you to search for repo ::: :::: -Once you have found the required report, you can handle the reported [user](handle_users.md) or [content](handle_content.md). You can also update the [internal notes](internal_notes.md) on the report. +Once you have found the required report, you can handle the reported [user](users.md) or [content](content.md). You can also update the [internal notes](notes.md) on the report. diff --git a/docs/moderator_documentation/reports/handle_users.md b/docs/moderator/reports/users.md similarity index 77% rename from docs/moderator_documentation/reports/handle_users.md rename to docs/moderator/reports/users.md index 0cd2eb1da..bcf01e60e 100644 --- a/docs/moderator_documentation/reports/handle_users.md +++ b/docs/moderator/reports/users.md @@ -19,7 +19,7 @@ To open a user's moderation page: 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. [Search for the report](search_reports.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens. +4. [Search for the report](search.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens. ::: @@ -29,7 +29,7 @@ To open a user's moderation page: 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. [Search for the report](search_reports.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens. +4. [Search for the report](search.md) and select {guilabel}`Open in moderation interface` under {guilabel}`Reported object`. The user's moderation page opens. ::: :::: @@ -40,4 +40,4 @@ You can change the following settings in the moderation interface: - {guilabel}`Permissions` – add or remove permissions associated with the user. - {guilabel}`Upload quota` – change the amount of data (in megabytes) that the user can upload. -Once you have made your changes, return to the {guilabel}`Reports` page and {guilabel}`Resolve` the report. Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](internal_notes.md) to keep a record of your changes. +Once you have made your changes, return to the {guilabel}`Reports` page and {guilabel}`Resolve` the report. Resolving the report assigns it to you so other moderators know who handled the report. Add [internal notes](notes.md) to keep a record of your changes. diff --git a/docs/moderator_documentation/reports/view_reports.md b/docs/moderator/reports/view.md similarity index 94% rename from docs/moderator_documentation/reports/view_reports.md rename to docs/moderator/reports/view.md index e706d0538..d3bc68dab 100644 --- a/docs/moderator_documentation/reports/view_reports.md +++ b/docs/moderator/reports/view.md @@ -45,7 +45,7 @@ That's it! A list of unresolved reports appears on the screen. The summary conta - A summary of the {guilabel}`Reported object`. - A list of available {guilabel}`Actions`. -Use the tools on this page the handle the reported [content](handle_content.md) or [user](handle_users.md). +Use the tools on this page the handle the reported [content](content.md) or [user](users.md). ## Email notifications diff --git a/docs/redirects.txt b/docs/redirects.txt index 621d9b2ce..673f5908a 100644 --- a/docs/redirects.txt +++ b/docs/redirects.txt @@ -1,53 +1,52 @@ -cli/index.html, ../user_documentation/info/cli.html -cli/examples.html, ../user_documentation/info/cli.html#examples -installation/optimization.html, ../admin/optimization.html -users/create.html, ../user_documentation/accounts/create_account.html -users/tagging.html, ../user_documentation/libraries/tag_music.html -users/upload.html, ../user_documentation/libraries/upload_content.html -users/editing.html, ../user_documentation/libraries/edit_content.html -users/account.html, ../user_documentation/accounts/index.html -users/queue.html, ../user_documentation/queue/index.html -users/managing.html, ../user_documentation/libraries/index.html -users/channels.html, ../user_documentation/channels/index.html -users/playlists.html, ../user_documentation/radios/index.html -users/favorites.html, ../user_documentation/favorites/index.html -users/radios.html, ../user_documentation/radios/index.html -users/followchannel.html, ../user_documentation/channels/follow_channel.html -users/follow.html, ../user_documentation/libraries/follow_library.html -users/reports.html, ../user_documentation/reports/index.html -users/builtinplugins.html, ../user_documentation/plugins/index.html -moderator/index.html, ../moderator_documentation/index.html -moderator/reports.html, ../moderator_documentation/reports/index.html -moderator/domains.html, ../moderator_documentation/domains/index.html -moderator/users.html, ../moderator_documentation/users/index.html -moderator/listing.html, ../moderator_documentation/allow_listing/index.html -admin/index.html, ../administrator_documentation/index.html -installation/index.html, ../administrator_documentation/installation_docs/index.html -installation/index.html#quick-install, ../administrator_documentation/installation_docs/quick_install.html -installation/docker.html, ../administrator_documentation/installation_docs/docker.html -installation/debian.html, ../administrator_documentation/installation_docs/debian.html -troubleshooting.html, administrator_documentation/troubleshooting/index.html -admin/debugging.html, ../administrator_documentation/troubleshooting/index.html -configuration.html, administrator_documentation/configuration_docs/index.html -upgrading/index.html, ../administrator_documentation/upgrade_docs/index.html -users/django.html, ../administrator_documentation/django/index.html -installation/ldap.html, ../administrator_documentation/configuration_docs/ldap.html -importing-music.html, administrator_documentation/import_docs/index.html -configuration.html, administrator_documentation/configuration_docs/index.html -upgrading/index.html, ../administrator_documentation/upgrade_docs/index.html -users/django.html, ../administrator_documentation/django/index.html -backup.html, ../administrator_documentation/upgrade_docs/backup.html -admin/migration.html, ../administrator_documentation/installation_docs/migrate.html -admin/commands.html, ../administrator_documentation/manage_script/index.html -admin/mrf.html, ../administrator_documentation/configuration_docs/mrf.html -admin/url.html, ../administrator_documentation/configuration_docs/change_url.html -admin/optimization.html, ../administrator_documentation/configuration_docs/optimize.html -architecture.html, ../developer_documentation/architecture.html -contributing.html, ../developer_documentation/index.html -api.html, ../developer_documentation/api/index.html -federation/index.html, ../developer_documentation/federation/index.html -developers/subsonic.html, ../developer_documentation/api/subsonic.html -developers/plugins.html, ../developer_documentation/plugins/index.html -developers/authentication.html, ../developer_documentation/api/authentication.html -documentation/index.html, ../contributor_documentation/documentation.html -translators.html, ../contributor_documentation/translation.html +cli/index.html, ../user/info/cli.html +cli/examples.html, ../user/info/cli.html#examples +users/create.html, ../user/accounts/create.html +users/tagging.html, ../user/libraries/content/tag.html +users/upload.html, ../user/libraries/content/upload.html +users/editing.html, ../user/libraries/content/edit.html +users/account.html, ../user/accounts/index.html +users/queue.html, ../user/queue/index.html +users/managing.html, ../user/libraries/index.html +users/channels.html, ../user/channels/index.html +users/playlists.html, ../user/radios/index.html +users/favorites.html, ../user/favorites/index.html +users/radios.html, ../user/radios/index.html +users/followchannel.html, ../user/channels/follow.html +users/follow.html, ../user/libraries/follow.html +users/reports.html, ../user/reports/index.html +users/builtinplugins.html, ../user/plugins/index.html +moderator/index.html, ../moderator/index.html +moderator/reports.html, ../moderator/reports/index.html +moderator/domains.html, ../moderator/domains/index.html +moderator/users.html, ../moderator/users/index.html +moderator/listing.html, ../moderator/allow_listing/index.html +admin/index.html, ../administrator/index.html +installation/index.html, ../administrator/installation/index.html +installation/index.html#quick-install, ../administrator/installation/quick_install.html +installation/docker.html, ../administrator/installation/docker.html +installation/debian.html, ../administrator/installation/debian.html +troubleshooting.html, administrator/troubleshooting/index.html +admin/debugging.html, ../administrator/troubleshooting/index.html +configuration.html, administrator/configuration/index.html +upgrading/index.html, ../administrator/upgrade/index.html +users/django.html, ../administrator/django/index.html +installation/ldap.html, ../administrator/configuration/ldap.html +importing-music.html, administrator/import.html +configuration.html, administrator/configuration/index.html +upgrading/index.html, ../administrator/upgrade/index.html +users/django.html, ../administrator/django/index.html +backup.html, ../administrator/upgrade/backup.html +admin/migration.html, ../administrator/installation/migrate.html +admin/commands.html, ../administrator/manage_script/index.html +admin/mrf.html, ../administrator/configuration/mrf.html +admin/url.html, ../administrator/configuration/change_url.html +admin/optimization.html, ../administrator/configuration/optimize.html +architecture.html, ../developer/architecture.html +contributing.html, ../developer/index.html +api.html, ../developer/api/index.html +federation/index.html, ../developer/federation/index.html +developers/subsonic.html, ../developer/api/subsonic.html +developers/plugins.html, ../developer/plugins/index.html +developers/authentication.html, ../developer/api/authentication.html +documentation/index.html, ../contributor/documentation.html +translators.html, ../contributor/translation.html diff --git a/docs/user_documentation/accounts/activity_visibility.md b/docs/user/accounts/activity.md similarity index 100% rename from docs/user_documentation/accounts/activity_visibility.md rename to docs/user/accounts/activity.md diff --git a/docs/user_documentation/accounts/add_avatar.md b/docs/user/accounts/avatar/add.md similarity index 100% rename from docs/user_documentation/accounts/add_avatar.md rename to docs/user/accounts/avatar/add.md diff --git a/docs/user_documentation/accounts/delete_avatar.md b/docs/user/accounts/avatar/delete.md similarity index 100% rename from docs/user_documentation/accounts/delete_avatar.md rename to docs/user/accounts/avatar/delete.md diff --git a/docs/user_documentation/accounts/create_account.md b/docs/user/accounts/create.md similarity index 100% rename from docs/user_documentation/accounts/create_account.md rename to docs/user/accounts/create.md diff --git a/docs/user_documentation/accounts/delete_account.md b/docs/user/accounts/delete.md similarity index 97% rename from docs/user_documentation/accounts/delete_account.md rename to docs/user/accounts/delete.md index 6d02449e2..16264a76c 100644 --- a/docs/user_documentation/accounts/delete_account.md +++ b/docs/user/accounts/delete.md @@ -47,4 +47,4 @@ To delete your account: ::: :::: -That's it! You've deleted your account. You can [create another account](create_account.md) at any time. +That's it! You've deleted your account. You can [create another account](create.md) at any time. diff --git a/docs/user_documentation/accounts/change_email.md b/docs/user/accounts/email.md similarity index 100% rename from docs/user_documentation/accounts/change_email.md rename to docs/user/accounts/email.md diff --git a/docs/user_documentation/accounts/index.md b/docs/user/accounts/index.md similarity index 77% rename from docs/user_documentation/accounts/index.md rename to docs/user/accounts/index.md index e58e6c7a8..bc99f86eb 100644 --- a/docs/user_documentation/accounts/index.md +++ b/docs/user/accounts/index.md @@ -10,9 +10,9 @@ maxdepth: 1 caption: Manage your account --- -create_account -check_quota -delete_account +create +quota +delete ``` @@ -22,10 +22,10 @@ maxdepth: 1 caption: Change account settings --- -change_email -change_password -add_avatar -delete_avatar -activity_visibility +email +password +avatar/add +avatar/delete +activity ``` diff --git a/docs/user_documentation/accounts/change_password.md b/docs/user/accounts/password.md similarity index 100% rename from docs/user_documentation/accounts/change_password.md rename to docs/user/accounts/password.md diff --git a/docs/user_documentation/accounts/check_quota.md b/docs/user/accounts/quota.md similarity index 100% rename from docs/user_documentation/accounts/check_quota.md rename to docs/user/accounts/quota.md diff --git a/docs/user_documentation/channels/delete_artist.md b/docs/user/channels/artist/delete.md similarity index 98% rename from docs/user_documentation/channels/delete_artist.md rename to docs/user/channels/artist/delete.md index 69ac1e8df..2873109d2 100644 --- a/docs/user_documentation/channels/delete_artist.md +++ b/docs/user/channels/artist/delete.md @@ -47,7 +47,7 @@ To delete a single track from a channel: ::: :::: -That's it! You've deleted your track. You can add it again by [uploading it to your channel](upload_artist.md). +That's it! You've deleted your track. You can add it again by [uploading it to your channel](upload.md). ## Delete an album @@ -88,4 +88,4 @@ Delete an album to remove all tracks it contains. To do this: ::: :::: -You're done! You've deleted the album and all the tracks it contained. You can add them again by [uploading it to your channel](upload_artist.md). +You're done! You've deleted the album and all the tracks it contained. You can add them again by [uploading it to your channel](upload.md). diff --git a/docs/user_documentation/channels/upload_artist.md b/docs/user/channels/artist/upload.md similarity index 97% rename from docs/user_documentation/channels/upload_artist.md rename to docs/user/channels/artist/upload.md index cd8c929d2..ba149ed1e 100644 --- a/docs/user_documentation/channels/upload_artist.md +++ b/docs/user/channels/artist/upload.md @@ -1,6 +1,6 @@ # Upload content to an Artist channel -Once you have [created a channel](create_channel.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods `. +Once you have [created a channel](../create.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods `. You can also create albums to organize your channel content. diff --git a/docs/user_documentation/channels/create_channel.md b/docs/user/channels/create.md similarity index 98% rename from docs/user_documentation/channels/create_channel.md rename to docs/user/channels/create.md index 1b4328446..620201572 100644 --- a/docs/user_documentation/channels/create_channel.md +++ b/docs/user/channels/create.md @@ -53,7 +53,7 @@ To create an **Artist discography** channel: ::: :::: -That's it! You've created your artist channel. You can now [add some music to it](upload_artist.md). +That's it! You've created your artist channel. You can now [add some music to it](artist/upload.md). ## Podcast @@ -106,4 +106,4 @@ To create a **Podcast** channel: ::: :::: -You're done! You've created your podcast channel. Now you can [add some episodes to it](upload_podcast.md). +You're done! You've created your podcast channel. Now you can [add some episodes to it](podcast/upload.md). diff --git a/docs/user_documentation/channels/delete_channel.md b/docs/user/channels/delete.md similarity index 100% rename from docs/user_documentation/channels/delete_channel.md rename to docs/user/channels/delete.md diff --git a/docs/user_documentation/channels/edit_channel.md b/docs/user/channels/edit.md similarity index 100% rename from docs/user_documentation/channels/edit_channel.md rename to docs/user/channels/edit.md diff --git a/docs/user_documentation/channels/follow_channel.md b/docs/user/channels/follow.md similarity index 100% rename from docs/user_documentation/channels/follow_channel.md rename to docs/user/channels/follow.md diff --git a/docs/user_documentation/channels/index.md b/docs/user/channels/index.md similarity index 84% rename from docs/user_documentation/channels/index.md rename to docs/user/channels/index.md index 6e9489af6..83e58b2ac 100644 --- a/docs/user_documentation/channels/index.md +++ b/docs/user/channels/index.md @@ -15,9 +15,9 @@ caption: Manage your channels maxdepth: 1 --- -create_channel -edit_channel -delete_channel +create +edit +delete ``` @@ -27,10 +27,10 @@ caption: Manage channel content maxdepth: 1 --- -upload_artist -upload_podcast -delete_artist -delete_podcast +artist/upload +artist/delete +podcast/upload +podcast/delete ``` @@ -40,7 +40,7 @@ caption: Follow channels maxdepth: 1 --- -follow_channel -subscribe_rss +follow +rss ``` diff --git a/docs/user_documentation/channels/delete_podcast.md b/docs/user/channels/podcast/delete.md similarity index 98% rename from docs/user_documentation/channels/delete_podcast.md rename to docs/user/channels/podcast/delete.md index 911b27394..007de3a78 100644 --- a/docs/user_documentation/channels/delete_podcast.md +++ b/docs/user/channels/podcast/delete.md @@ -47,7 +47,7 @@ To delete a single episode from a channel: ::: :::: -That's it! You've deleted your episode. You can add it again by [uploading it to your channel](upload_podcast.md). +That's it! You've deleted your episode. You can add it again by [uploading it to your channel](upload.md). ## Delete a series @@ -88,4 +88,4 @@ Delete a series to remove all episodes it contains. To do this: ::: :::: -You're done! You've deleted the series and all the episodes it contained. You can add them again by [uploading it to your channel](upload_podcast.md). +You're done! You've deleted the series and all the episodes it contained. You can add them again by [uploading it to your channel](upload.md). diff --git a/docs/user_documentation/channels/upload_podcast.md b/docs/user/channels/podcast/upload.md similarity index 97% rename from docs/user_documentation/channels/upload_podcast.md rename to docs/user/channels/podcast/upload.md index ef6d105c5..c14936639 100644 --- a/docs/user_documentation/channels/upload_podcast.md +++ b/docs/user/channels/podcast/upload.md @@ -1,6 +1,6 @@ # Upload content to an Podcast channel -Once you have [created a channel](create_channel.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods `. +Once you have [created a channel](../create.md), you can start to add content to it. Users who follow your channel can see and play your content from their {term}`pods `. You can also create series to organize your channel content. diff --git a/docs/user_documentation/channels/subscribe_rss.md b/docs/user/channels/rss.md similarity index 100% rename from docs/user_documentation/channels/subscribe_rss.md rename to docs/user/channels/rss.md diff --git a/docs/user_documentation/favorites/add_favorites.md b/docs/user/favorites/add.md similarity index 100% rename from docs/user_documentation/favorites/add_favorites.md rename to docs/user/favorites/add.md diff --git a/docs/user_documentation/favorites/index.md b/docs/user/favorites/index.md similarity index 87% rename from docs/user_documentation/favorites/index.md rename to docs/user/favorites/index.md index 141418920..962e72405 100644 --- a/docs/user_documentation/favorites/index.md +++ b/docs/user/favorites/index.md @@ -8,7 +8,7 @@ caption: Manage your favorites maxdepth: 1 --- -add_favorites -remove_favorites +add +remove ``` diff --git a/docs/user_documentation/favorites/remove_favorites.md b/docs/user/favorites/remove.md similarity index 100% rename from docs/user_documentation/favorites/remove_favorites.md rename to docs/user/favorites/remove.md diff --git a/docs/user_documentation/index.md b/docs/user/index.md similarity index 100% rename from docs/user_documentation/index.md rename to docs/user/index.md diff --git a/docs/user_documentation/info/cli.rst b/docs/user/info/cli.rst similarity index 100% rename from docs/user_documentation/info/cli.rst rename to docs/user/info/cli.rst diff --git a/docs/user_documentation/libraries/delete_content.md b/docs/user/libraries/content/delete.md similarity index 100% rename from docs/user_documentation/libraries/delete_content.md rename to docs/user/libraries/content/delete.md diff --git a/docs/user_documentation/libraries/edit_content.md b/docs/user/libraries/content/edit.md similarity index 99% rename from docs/user_documentation/libraries/edit_content.md rename to docs/user/libraries/content/edit.md index d0fca5938..d293b9863 100644 --- a/docs/user_documentation/libraries/edit_content.md +++ b/docs/user/libraries/content/edit.md @@ -4,7 +4,7 @@ You can only edit content in libraries you own. {term}`Pod` admins can edit all content. ``` -You can edit library content after you have uploaded it. This is helpful if the content isn't [tagged](./tag_music.md). +You can edit library content after you have uploaded it. This is helpful if the content isn't [tagged](tag.md). ```{contents} :local: diff --git a/docs/user_documentation/libraries/tag_music.md b/docs/user/libraries/content/tag.md similarity index 99% rename from docs/user_documentation/libraries/tag_music.md rename to docs/user/libraries/content/tag.md index c5142188d..4f38caba1 100644 --- a/docs/user_documentation/libraries/tag_music.md +++ b/docs/user/libraries/content/tag.md @@ -82,7 +82,7 @@ To tag content using MusicBrainz Picard: 4. Check a file's tags by highlighting it and looking at the details in the bottom panel. If Picard has applied the wrong tags, look for [alternative versions](#alternative-versions). 5. Select {guilabel}`Save` or hit {kbd}`ctrl+s` ({kbd}`cmd+s` on macOS) to save the tags to the files. -That's it! You've added ID3 tags to your files. You can now [add these to a library](upload_content.md) +That's it! You've added ID3 tags to your files. You can now [add these to a library](upload.md) ## Alternative versions diff --git a/docs/user_documentation/libraries/upload_content.md b/docs/user/libraries/content/upload.md similarity index 87% rename from docs/user_documentation/libraries/upload_content.md rename to docs/user/libraries/content/upload.md index 72f7982df..d6e69e065 100644 --- a/docs/user_documentation/libraries/upload_content.md +++ b/docs/user/libraries/content/upload.md @@ -4,7 +4,7 @@ Access to a library's content is set at a __library level__. You can't change the privacy level of content within the library. ``` -Once you have [created a library](create_library.md), you can start uploading content to it. Funkwhale reads information about your content from its metadata. For the best results, make sure to [tag your files well](tag_music.md). +Once you have [created a library](../create.md), you can start uploading content to it. Funkwhale reads information about your content from its metadata. For the best results, make sure to [tag your files well](tag.md). To upload content to a library: diff --git a/docs/user_documentation/libraries/create_library.md b/docs/user/libraries/create.md similarity index 100% rename from docs/user_documentation/libraries/create_library.md rename to docs/user/libraries/create.md diff --git a/docs/user_documentation/libraries/delete_library.md b/docs/user/libraries/delete.md similarity index 100% rename from docs/user_documentation/libraries/delete_library.md rename to docs/user/libraries/delete.md diff --git a/docs/user_documentation/libraries/edit_library.md b/docs/user/libraries/edit.md similarity index 100% rename from docs/user_documentation/libraries/edit_library.md rename to docs/user/libraries/edit.md diff --git a/docs/user_documentation/libraries/follow_library.md b/docs/user/libraries/follow.md similarity index 100% rename from docs/user_documentation/libraries/follow_library.md rename to docs/user/libraries/follow.md diff --git a/docs/user_documentation/libraries/index.md b/docs/user/libraries/index.md similarity index 88% rename from docs/user_documentation/libraries/index.md rename to docs/user/libraries/index.md index 06f913922..b2a8d034a 100644 --- a/docs/user_documentation/libraries/index.md +++ b/docs/user/libraries/index.md @@ -14,9 +14,9 @@ caption: Manage your libraries maxdepth: 1 --- -create_library -edit_library -delete_library +create +edit +delete ``` @@ -26,10 +26,10 @@ caption: Manage library content maxdepth: 1 --- -tag_music -upload_content -edit_content -delete_content +content/tag +content/upload +content/edit +content/delete ``` @@ -39,7 +39,7 @@ caption: Share and follow libraries maxdepth: 1 --- -share_library -follow_library +share +follow ``` diff --git a/docs/user_documentation/libraries/share_library.md b/docs/user/libraries/share.md similarity index 100% rename from docs/user_documentation/libraries/share_library.md rename to docs/user/libraries/share.md diff --git a/docs/user_documentation/playlists/add_content.md b/docs/user/playlists/content/add.md similarity index 98% rename from docs/user_documentation/playlists/add_content.md rename to docs/user/playlists/content/add.md index 0b4156335..d04236b45 100644 --- a/docs/user_documentation/playlists/add_content.md +++ b/docs/user/playlists/content/add.md @@ -34,7 +34,7 @@ That's it! The currently playing track is now in your playlist. ## Add content from queue -You can add all content that is currently in your [player queue](../queue/index.md). To do this: +You can add all content that is currently in your [player queue](../../queue/index.md). To do this: ::::{tab-set} diff --git a/docs/user_documentation/playlists/remove_content.md b/docs/user/playlists/content/remove.md similarity index 100% rename from docs/user_documentation/playlists/remove_content.md rename to docs/user/playlists/content/remove.md diff --git a/docs/user_documentation/playlists/reorder_content.md b/docs/user/playlists/content/reorder.md similarity index 100% rename from docs/user_documentation/playlists/reorder_content.md rename to docs/user/playlists/content/reorder.md diff --git a/docs/user_documentation/playlists/create_playlist.md b/docs/user/playlists/create.md similarity index 98% rename from docs/user_documentation/playlists/create_playlist.md rename to docs/user/playlists/create.md index 5f5b64026..6d02f0c2b 100644 --- a/docs/user_documentation/playlists/create_playlist.md +++ b/docs/user/playlists/create.md @@ -38,4 +38,4 @@ To create a playlist: ::: :::: -Congratulations! You've created your playlist. Now you can [add some content to it](add_content.md). +Congratulations! You've created your playlist. Now you can [add some content to it](content/add.md). diff --git a/docs/user_documentation/playlists/delete_playlist.md b/docs/user/playlists/delete.md similarity index 100% rename from docs/user_documentation/playlists/delete_playlist.md rename to docs/user/playlists/delete.md diff --git a/docs/user_documentation/playlists/edit_playlist.md b/docs/user/playlists/edit.md similarity index 100% rename from docs/user_documentation/playlists/edit_playlist.md rename to docs/user/playlists/edit.md diff --git a/docs/user_documentation/playlists/index.md b/docs/user/playlists/index.md similarity index 73% rename from docs/user_documentation/playlists/index.md rename to docs/user/playlists/index.md index 2c7f60422..984e1559c 100644 --- a/docs/user_documentation/playlists/index.md +++ b/docs/user/playlists/index.md @@ -8,10 +8,10 @@ caption: Manage your playlists maxdepth: 1 --- -create_playlist -edit_playlist -listen_playlist -delete_playlist +create +edit +listen +delete ``` @@ -21,8 +21,8 @@ caption: Manage playlist content maxdepth: 1 --- -add_content -reorder_content -remove_content +content/add +content/reorder +content/remove ``` diff --git a/docs/user_documentation/playlists/listen_playlist.md b/docs/user/playlists/listen.md similarity index 99% rename from docs/user_documentation/playlists/listen_playlist.md rename to docs/user/playlists/listen.md index 3b08451b3..15eda0ca8 100644 --- a/docs/user_documentation/playlists/listen_playlist.md +++ b/docs/user/playlists/listen.md @@ -1,7 +1,7 @@ # Listen to a playlist ```{note} -You can only listen to content in libraries you have access to. For more information, see [Follow a library](../libraries/follow_library). +You can only listen to content in libraries you have access to. For more information, see [Follow a library](../libraries/follow). ``` You can listen to your playlists or playlists created by other users of your {term}`pod`. diff --git a/docs/user_documentation/plugins/index.md b/docs/user/plugins/index.md similarity index 89% rename from docs/user_documentation/plugins/index.md rename to docs/user/plugins/index.md index 061170df4..a66fafa58 100644 --- a/docs/user_documentation/plugins/index.md +++ b/docs/user/plugins/index.md @@ -12,8 +12,8 @@ maxdepth: 1 caption: Core plugins --- -scrobbler_plugin -listenbrainz_plugin -maloja_plugin +scrobbler +listenbrainz +maloja ``` diff --git a/docs/user_documentation/plugins/listenbrainz_plugin.md b/docs/user/plugins/listenbrainz.md similarity index 100% rename from docs/user_documentation/plugins/listenbrainz_plugin.md rename to docs/user/plugins/listenbrainz.md diff --git a/docs/user_documentation/plugins/maloja_plugin.md b/docs/user/plugins/maloja.md similarity index 100% rename from docs/user_documentation/plugins/maloja_plugin.md rename to docs/user/plugins/maloja.md diff --git a/docs/user_documentation/plugins/scrobbler_plugin.md b/docs/user/plugins/scrobbler.md similarity index 97% rename from docs/user_documentation/plugins/scrobbler_plugin.md rename to docs/user/plugins/scrobbler.md index 4297c0a54..290e40c9a 100644 --- a/docs/user_documentation/plugins/scrobbler_plugin.md +++ b/docs/user/plugins/scrobbler.md @@ -7,7 +7,7 @@ If you want to use [Last.fm](https://last.fm) to scrobble your listens, your pod The **Scrobbler** plugin enables you to submit ({term}`scrobble`) listens to a scrobbler service. Scrobbling listens helps you build up a profile of your music tastes. It also enables you to keep a record of your listens. ```{tip} -Using ListenBrainz or Maloja? Check out the [ListenBrainz](listenbrainz_plugin) and [Maloja](maloja_plugin) plugins! +Using ListenBrainz or Maloja? Check out the [ListenBrainz](listenbrainz.md) and [Maloja](maloja.md) plugins! ``` The **Scrobbler** plugin supports any scrobbling service that uses the Audioscrobbler protocol. To set up the **Scrobbler plugin**: diff --git a/docs/user_documentation/queue/add_album.md b/docs/user/queue/album.md similarity index 100% rename from docs/user_documentation/queue/add_album.md rename to docs/user/queue/album.md diff --git a/docs/user_documentation/queue/add_artist.md b/docs/user/queue/artist.md similarity index 100% rename from docs/user_documentation/queue/add_artist.md rename to docs/user/queue/artist.md diff --git a/docs/user_documentation/queue/index.md b/docs/user/queue/index.md similarity index 74% rename from docs/user_documentation/queue/index.md rename to docs/user/queue/index.md index 31bed81bd..a8a216d8f 100644 --- a/docs/user_documentation/queue/index.md +++ b/docs/user/queue/index.md @@ -10,12 +10,12 @@ caption: Manage your queue maxdepth: 1 --- -add_tracks -add_album -add_series -add_artist -add_playlist -rearrange_content -remove_content +tracks +album +series +artist +playlist +rearrange +remove ``` diff --git a/docs/user_documentation/queue/add_playlist.md b/docs/user/queue/playlist.md similarity index 100% rename from docs/user_documentation/queue/add_playlist.md rename to docs/user/queue/playlist.md diff --git a/docs/user_documentation/queue/rearrange_content.md b/docs/user/queue/rearrange.md similarity index 100% rename from docs/user_documentation/queue/rearrange_content.md rename to docs/user/queue/rearrange.md diff --git a/docs/user_documentation/queue/remove_content.md b/docs/user/queue/remove.md similarity index 100% rename from docs/user_documentation/queue/remove_content.md rename to docs/user/queue/remove.md diff --git a/docs/user_documentation/queue/add_series.md b/docs/user/queue/series.md similarity index 100% rename from docs/user_documentation/queue/add_series.md rename to docs/user/queue/series.md diff --git a/docs/user_documentation/queue/add_tracks.md b/docs/user/queue/tracks.md similarity index 100% rename from docs/user_documentation/queue/add_tracks.md rename to docs/user/queue/tracks.md diff --git a/docs/user_documentation/radios/create_radio.md b/docs/user/radios/create.md similarity index 100% rename from docs/user_documentation/radios/create_radio.md rename to docs/user/radios/create.md diff --git a/docs/user_documentation/radios/delete_radio.md b/docs/user/radios/delete.md similarity index 97% rename from docs/user_documentation/radios/delete_radio.md rename to docs/user/radios/delete.md index ec93a2654..115e1d603 100644 --- a/docs/user_documentation/radios/delete_radio.md +++ b/docs/user/radios/delete.md @@ -30,4 +30,4 @@ If you no longer want a radio, you can delete it. To do this: ::: :::: -That's it! You've deleted your radio. You can [create a new one](create_radio.md) at any time. +That's it! You've deleted your radio. You can [create a new one](create.md) at any time. diff --git a/docs/user_documentation/radios/edit_radio.md b/docs/user/radios/edit.md similarity index 100% rename from docs/user_documentation/radios/edit_radio.md rename to docs/user/radios/edit.md diff --git a/docs/user_documentation/radios/index.md b/docs/user/radios/index.md similarity index 94% rename from docs/user_documentation/radios/index.md rename to docs/user/radios/index.md index 80f959d0b..6944e2ba8 100644 --- a/docs/user_documentation/radios/index.md +++ b/docs/user/radios/index.md @@ -16,9 +16,9 @@ caption: Manage your radios maxdepth: 1 --- -create_radio -edit_radio -listen_radio -delete_radio +create +edit +listen +delete ``` diff --git a/docs/user_documentation/radios/listen_radio.md b/docs/user/radios/listen.md similarity index 99% rename from docs/user_documentation/radios/listen_radio.md rename to docs/user/radios/listen.md index 29c171e25..159f51c7e 100644 --- a/docs/user_documentation/radios/listen_radio.md +++ b/docs/user/radios/listen.md @@ -1,7 +1,7 @@ # Listen to a radio ```{note} -You can only listen to content in libraries you have access to. For more information, see [Follow a library](../libraries/follow_library). +You can only listen to content in libraries you have access to. For more information, see [Follow a library](../libraries/follow). ``` You can listen to your radios or public radios created by other users of your {term}`pod`. diff --git a/docs/user_documentation/reports/report_account.md b/docs/user/reports/account.md similarity index 100% rename from docs/user_documentation/reports/report_account.md rename to docs/user/reports/account.md diff --git a/docs/user_documentation/reports/report_album.md b/docs/user/reports/album.md similarity index 100% rename from docs/user_documentation/reports/report_album.md rename to docs/user/reports/album.md diff --git a/docs/user_documentation/reports/report_artist.md b/docs/user/reports/artist.md similarity index 100% rename from docs/user_documentation/reports/report_artist.md rename to docs/user/reports/artist.md diff --git a/docs/user_documentation/reports/report_channel.md b/docs/user/reports/channel.md similarity index 100% rename from docs/user_documentation/reports/report_channel.md rename to docs/user/reports/channel.md diff --git a/docs/user_documentation/reports/index.md b/docs/user/reports/index.md similarity index 84% rename from docs/user_documentation/reports/index.md rename to docs/user/reports/index.md index 23baa84ad..331e83e3f 100644 --- a/docs/user_documentation/reports/index.md +++ b/docs/user/reports/index.md @@ -12,12 +12,12 @@ caption: Submit reports maxdepth: 1 --- -report_account -report_channel -report_library -report_track -report_album -report_artist -report_playlist +account +channel +library +track +album +artist +playlist ``` diff --git a/docs/user_documentation/reports/report_library.md b/docs/user/reports/library.md similarity index 100% rename from docs/user_documentation/reports/report_library.md rename to docs/user/reports/library.md diff --git a/docs/user_documentation/reports/report_playlist.md b/docs/user/reports/playlist.md similarity index 100% rename from docs/user_documentation/reports/report_playlist.md rename to docs/user/reports/playlist.md diff --git a/docs/user_documentation/reports/report_track.md b/docs/user/reports/track.md similarity index 100% rename from docs/user_documentation/reports/report_track.md rename to docs/user/reports/track.md diff --git a/docs/user_documentation/subsonic/disable_subsonic.md b/docs/user/subsonic/disable.md similarity index 97% rename from docs/user_documentation/subsonic/disable_subsonic.md rename to docs/user/subsonic/disable.md index ab5814cb8..6673a2d18 100644 --- a/docs/user_documentation/subsonic/disable_subsonic.md +++ b/docs/user/subsonic/disable.md @@ -31,4 +31,4 @@ If you don't want to use Subsonic any more, you can disable access. This stops a ::: :::: -You're done! Subsonic apps can no longer access your account. You can re-enable the API at any time by [requesting a new password](./subsonic_password.md). +You're done! Subsonic apps can no longer access your account. You can re-enable the API at any time by [requesting a new password](password/request.md). diff --git a/docs/user_documentation/subsonic/index.md b/docs/user/subsonic/index.md similarity index 90% rename from docs/user_documentation/subsonic/index.md rename to docs/user/subsonic/index.md index 1a389d4a3..2b1a04a93 100644 --- a/docs/user_documentation/subsonic/index.md +++ b/docs/user/subsonic/index.md @@ -12,8 +12,8 @@ maxdepth: 1 caption: Manage your Subsonic access --- -subsonic_password -reset_subsonic -disable_subsonic +password/request +password/reset +disable ``` diff --git a/docs/user_documentation/subsonic/subsonic_password.md b/docs/user/subsonic/password/request.md similarity index 100% rename from docs/user_documentation/subsonic/subsonic_password.md rename to docs/user/subsonic/password/request.md diff --git a/docs/user_documentation/subsonic/reset_subsonic.md b/docs/user/subsonic/password/reset.md similarity index 100% rename from docs/user_documentation/subsonic/reset_subsonic.md rename to docs/user/subsonic/password/reset.md