From 88e7f9cb564262f38f8a49037ed68efe6b79feed Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Wed, 1 Feb 2023 14:15:00 +0100 Subject: [PATCH] docs: use hyphen as string separator Part-of: --- .../configuration/{change_url.md => change-url.md} | 0 .../configuration/{env_file.md => env-file.md} | 0 docs/administrator/configuration/index.md | 8 ++++---- .../{instance_settings.md => instance-settings.md} | 0 .../{object_storage.md => object-storage.md} | 0 docs/administrator/configuration/rate-limiting.md | 2 +- .../django/{delete_content.md => delete-content.md} | 0 docs/administrator/django/index.md | 2 +- docs/administrator/import.md | 4 ++-- docs/administrator/index.md | 4 ++-- docs/administrator/installation/index.md | 4 ++-- .../{quick_install.md => quick-install.md} | 0 .../installation/{third_party.md => third-party.md} | 0 .../create-library.md} | 0 .../{manage_script => manage-script}/database.md | 0 .../fix_uploads.md => manage-script/fix-uploads.md} | 0 .../{manage_script => manage-script}/index.md | 4 ++-- .../{manage_script => manage-script}/library.md | 0 .../{manage_script => manage-script}/tags.md | 0 .../{manage_script => manage-script}/thumbnails.md | 0 .../{manage_script => manage-script}/users.md | 0 .../administrator/{migration_guide.md => migration.md} | 0 docs/administrator/troubleshooting/backend.md | 2 +- docs/administrator/troubleshooting/frontend.md | 2 +- .../troubleshooting/{get_help.md => help.md} | 0 docs/administrator/troubleshooting/index.md | 2 +- docs/administrator/uninstall/index.md | 2 +- .../uninstall/{quick_install.md => quick-install.md} | 0 docs/administrator/upgrade/index.md | 2 +- .../upgrade/{quick_install.md => quick-install.md} | 2 +- docs/developer/api/index.md | 2 +- docs/developer/api/{rate_limit.md => rate-limit.md} | 0 docs/index.md | 10 +++++----- docs/moderator/{allow_listing => allow-listing}/add.md | 0 .../{allow_listing => allow-listing}/index.md | 0 .../{allow_listing => allow-listing}/remove.md | 0 .../{external_users => external-users}/index.md | 0 .../{external_users => external-users}/purge.md | 0 .../{external_users => external-users}/rules/add.md | 0 .../{external_users => external-users}/rules/delete.md | 0 .../{external_users => external-users}/rules/edit.md | 0 docs/moderator/index.md | 6 +++--- .../{internal_users => internal-users}/index.md | 0 .../{internal_users => internal-users}/registration.md | 0 docs/redirects.txt | 4 ++-- 45 files changed, 31 insertions(+), 31 deletions(-) rename docs/administrator/configuration/{change_url.md => change-url.md} (100%) rename docs/administrator/configuration/{env_file.md => env-file.md} (100%) rename docs/administrator/configuration/{instance_settings.md => instance-settings.md} (100%) rename docs/administrator/configuration/{object_storage.md => object-storage.md} (100%) rename docs/administrator/django/{delete_content.md => delete-content.md} (100%) rename docs/administrator/installation/{quick_install.md => quick-install.md} (100%) rename docs/administrator/installation/{third_party.md => third-party.md} (100%) rename docs/administrator/{manage_script/create_library.md => manage-script/create-library.md} (100%) rename docs/administrator/{manage_script => manage-script}/database.md (100%) rename docs/administrator/{manage_script/fix_uploads.md => manage-script/fix-uploads.md} (100%) rename docs/administrator/{manage_script => manage-script}/index.md (94%) rename docs/administrator/{manage_script => manage-script}/library.md (100%) rename docs/administrator/{manage_script => manage-script}/tags.md (100%) rename docs/administrator/{manage_script => manage-script}/thumbnails.md (100%) rename docs/administrator/{manage_script => manage-script}/users.md (100%) rename docs/administrator/{migration_guide.md => migration.md} (100%) rename docs/administrator/troubleshooting/{get_help.md => help.md} (100%) rename docs/administrator/uninstall/{quick_install.md => quick-install.md} (100%) rename docs/administrator/upgrade/{quick_install.md => quick-install.md} (82%) rename docs/developer/api/{rate_limit.md => rate-limit.md} (100%) rename docs/moderator/{allow_listing => allow-listing}/add.md (100%) rename docs/moderator/{allow_listing => allow-listing}/index.md (100%) rename docs/moderator/{allow_listing => allow-listing}/remove.md (100%) rename docs/moderator/{external_users => external-users}/index.md (100%) rename docs/moderator/{external_users => external-users}/purge.md (100%) rename docs/moderator/{external_users => external-users}/rules/add.md (100%) rename docs/moderator/{external_users => external-users}/rules/delete.md (100%) rename docs/moderator/{external_users => external-users}/rules/edit.md (100%) rename docs/moderator/{internal_users => internal-users}/index.md (100%) rename docs/moderator/{internal_users => internal-users}/registration.md (100%) diff --git a/docs/administrator/configuration/change_url.md b/docs/administrator/configuration/change-url.md similarity index 100% rename from docs/administrator/configuration/change_url.md rename to docs/administrator/configuration/change-url.md diff --git a/docs/administrator/configuration/env_file.md b/docs/administrator/configuration/env-file.md similarity index 100% rename from docs/administrator/configuration/env_file.md rename to docs/administrator/configuration/env-file.md diff --git a/docs/administrator/configuration/index.md b/docs/administrator/configuration/index.md index b593227b0..f194f6e65 100644 --- a/docs/administrator/configuration/index.md +++ b/docs/administrator/configuration/index.md @@ -8,13 +8,13 @@ caption: Configuration options maxdepth: 1 --- -Environment file -Instance settings -object_storage +Environment file +Instance settings +object-storage Frontend customization optimize ldap -change_url +change-url mrf rate-limiting diff --git a/docs/administrator/configuration/instance_settings.md b/docs/administrator/configuration/instance-settings.md similarity index 100% rename from docs/administrator/configuration/instance_settings.md rename to docs/administrator/configuration/instance-settings.md diff --git a/docs/administrator/configuration/object_storage.md b/docs/administrator/configuration/object-storage.md similarity index 100% rename from docs/administrator/configuration/object_storage.md rename to docs/administrator/configuration/object-storage.md diff --git a/docs/administrator/configuration/rate-limiting.md b/docs/administrator/configuration/rate-limiting.md index 1fa3c928a..f45ae562e 100644 --- a/docs/administrator/configuration/rate-limiting.md +++ b/docs/administrator/configuration/rate-limiting.md @@ -1,6 +1,6 @@ # Rate limit API endpoints -This article contains a summary of the endpoints you can control using rate-limiting. You can change the rate limits for these endpoints using the [`THROTTLING_RATES`](env_file.md#api-configuration) environment variable. +This article contains a summary of the endpoints you can control using rate-limiting. You can change the rate limits for these endpoints using the [`THROTTLING_RATES`](env-file.md#api-configuration) environment variable. ## Standard endpoints diff --git a/docs/administrator/django/delete_content.md b/docs/administrator/django/delete-content.md similarity index 100% rename from docs/administrator/django/delete_content.md rename to docs/administrator/django/delete-content.md diff --git a/docs/administrator/django/index.md b/docs/administrator/django/index.md index c2e56d900..522d9a1df 100644 --- a/docs/administrator/django/index.md +++ b/docs/administrator/django/index.md @@ -13,6 +13,6 @@ caption: Administrative tasks maxdepth: 1 --- -delete_content +delete-content ``` diff --git a/docs/administrator/import.md b/docs/administrator/import.md index 4d8bcde77..abb1a6250 100644 --- a/docs/administrator/import.md +++ b/docs/administrator/import.md @@ -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/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/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/index.md b/docs/administrator/index.md index e9aa32613..f04268a57 100644 --- a/docs/administrator/index.md +++ b/docs/administrator/index.md @@ -16,8 +16,8 @@ Once you've installed Funkwhale, you can use [the guides in this section](config ## Upgrade your Funkwhale pod -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). +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.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/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/installation/index.md b/docs/administrator/installation/index.md index ff0706675..6358e6cf7 100644 --- a/docs/administrator/installation/index.md +++ b/docs/administrator/installation/index.md @@ -13,10 +13,10 @@ caption: Choose your installation method maxdepth: 1 --- -quick_install +quick-install docker debian -third_party +third-party ``` diff --git a/docs/administrator/installation/quick_install.md b/docs/administrator/installation/quick-install.md similarity index 100% rename from docs/administrator/installation/quick_install.md rename to docs/administrator/installation/quick-install.md diff --git a/docs/administrator/installation/third_party.md b/docs/administrator/installation/third-party.md similarity index 100% rename from docs/administrator/installation/third_party.md rename to docs/administrator/installation/third-party.md diff --git a/docs/administrator/manage_script/create_library.md b/docs/administrator/manage-script/create-library.md similarity index 100% rename from docs/administrator/manage_script/create_library.md rename to docs/administrator/manage-script/create-library.md diff --git a/docs/administrator/manage_script/database.md b/docs/administrator/manage-script/database.md similarity index 100% rename from docs/administrator/manage_script/database.md rename to docs/administrator/manage-script/database.md diff --git a/docs/administrator/manage_script/fix_uploads.md b/docs/administrator/manage-script/fix-uploads.md similarity index 100% rename from docs/administrator/manage_script/fix_uploads.md rename to docs/administrator/manage-script/fix-uploads.md diff --git a/docs/administrator/manage_script/index.md b/docs/administrator/manage-script/index.md similarity index 94% rename from docs/administrator/manage_script/index.md rename to docs/administrator/manage-script/index.md index 9f8a7c2c7..caa299ed2 100644 --- a/docs/administrator/manage_script/index.md +++ b/docs/administrator/manage-script/index.md @@ -8,12 +8,12 @@ caption: Administration tasks maxdepth: 1 --- -create_library +create-library Manage users Prune library Clean database Add album and artist tags thumbnails -fix_uploads +fix-uploads ``` diff --git a/docs/administrator/manage_script/library.md b/docs/administrator/manage-script/library.md similarity index 100% rename from docs/administrator/manage_script/library.md rename to docs/administrator/manage-script/library.md diff --git a/docs/administrator/manage_script/tags.md b/docs/administrator/manage-script/tags.md similarity index 100% rename from docs/administrator/manage_script/tags.md rename to docs/administrator/manage-script/tags.md diff --git a/docs/administrator/manage_script/thumbnails.md b/docs/administrator/manage-script/thumbnails.md similarity index 100% rename from docs/administrator/manage_script/thumbnails.md rename to docs/administrator/manage-script/thumbnails.md diff --git a/docs/administrator/manage_script/users.md b/docs/administrator/manage-script/users.md similarity index 100% rename from docs/administrator/manage_script/users.md rename to docs/administrator/manage-script/users.md diff --git a/docs/administrator/migration_guide.md b/docs/administrator/migration.md similarity index 100% rename from docs/administrator/migration_guide.md rename to docs/administrator/migration.md diff --git a/docs/administrator/troubleshooting/backend.md b/docs/administrator/troubleshooting/backend.md index 53a3a1dd3..9a065d43c 100644 --- a/docs/administrator/troubleshooting/backend.md +++ b/docs/administrator/troubleshooting/backend.md @@ -197,4 +197,4 @@ To disable memory tracing: ## Get help -If you can't solve the issue yourself, ask the community for help. Check out the [get help](get_help.md) guide for information about where to ask your question and what details to provide. +If you can't solve the issue yourself, ask the community for help. Check out the [get help](help.md) guide for information about where to ask your question and what details to provide. diff --git a/docs/administrator/troubleshooting/frontend.md b/docs/administrator/troubleshooting/frontend.md index a969e08a8..6cfd923fa 100644 --- a/docs/administrator/troubleshooting/frontend.md +++ b/docs/administrator/troubleshooting/frontend.md @@ -57,4 +57,4 @@ If you are receiving `4XX` or `5XX` responses, this means the API isn't serving ## Get help -If you can't solve the issue yourself, ask the community for help. Check out the [get help](get_help.md) guide for information about where to ask your question and what details to provide. +If you can't solve the issue yourself, ask the community for help. Check out the [get help](help.md) guide for information about where to ask your question and what details to provide. diff --git a/docs/administrator/troubleshooting/get_help.md b/docs/administrator/troubleshooting/help.md similarity index 100% rename from docs/administrator/troubleshooting/get_help.md rename to docs/administrator/troubleshooting/help.md diff --git a/docs/administrator/troubleshooting/index.md b/docs/administrator/troubleshooting/index.md index 00a8f17eb..eb962763d 100644 --- a/docs/administrator/troubleshooting/index.md +++ b/docs/administrator/troubleshooting/index.md @@ -18,6 +18,6 @@ maxdepth: 1 frontend backend -get_help +help ``` diff --git a/docs/administrator/uninstall/index.md b/docs/administrator/uninstall/index.md index a4c01251d..c9f4ce8a9 100644 --- a/docs/administrator/uninstall/index.md +++ b/docs/administrator/uninstall/index.md @@ -12,7 +12,7 @@ caption: Choose your setup maxdepth: 1 --- -quick_install +quick-install debian docker diff --git a/docs/administrator/uninstall/quick_install.md b/docs/administrator/uninstall/quick-install.md similarity index 100% rename from docs/administrator/uninstall/quick_install.md rename to docs/administrator/uninstall/quick-install.md diff --git a/docs/administrator/upgrade/index.md b/docs/administrator/upgrade/index.md index addec0e21..a36439dd1 100644 --- a/docs/administrator/upgrade/index.md +++ b/docs/administrator/upgrade/index.md @@ -24,7 +24,7 @@ caption: Choose your installation method maxdepth: 1 --- -Quick install script +Quick install script Docker Debian diff --git a/docs/administrator/upgrade/quick_install.md b/docs/administrator/upgrade/quick-install.md similarity index 82% rename from docs/administrator/upgrade/quick_install.md rename to docs/administrator/upgrade/quick-install.md index 6eb20b81b..aa3cded2f 100644 --- a/docs/administrator/upgrade/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/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/developer/api/index.md b/docs/developer/api/index.md index e5e9ef9b2..63bfef00b 100644 --- a/docs/developer/api/index.md +++ b/docs/developer/api/index.md @@ -12,7 +12,7 @@ maxdepth: 1 API explorer authentication -rate_limit +rate-limit subsonic ``` diff --git a/docs/developer/api/rate_limit.md b/docs/developer/api/rate-limit.md similarity index 100% rename from docs/developer/api/rate_limit.md rename to docs/developer/api/rate-limit.md diff --git a/docs/index.md b/docs/index.md index e67c3a2e6..99f2fc0eb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -38,9 +38,9 @@ administrator/installation/index administrator/configuration/index administrator/import administrator/upgrade/index -administrator/migration_guide +administrator/migration administrator/django/index -administrator/manage_script/index +administrator/manage-script/index administrator/uninstall/index administrator/troubleshooting/index @@ -55,11 +55,11 @@ hidden: true moderator/index moderator/reports/index -moderator/internal_users/index +moderator/internal-users/index moderator/content/index moderator/domains/index -moderator/external_users/index -moderator/allow_listing/index +moderator/external-users/index +moderator/allow-listing/index ``` diff --git a/docs/moderator/allow_listing/add.md b/docs/moderator/allow-listing/add.md similarity index 100% rename from docs/moderator/allow_listing/add.md rename to docs/moderator/allow-listing/add.md diff --git a/docs/moderator/allow_listing/index.md b/docs/moderator/allow-listing/index.md similarity index 100% rename from docs/moderator/allow_listing/index.md rename to docs/moderator/allow-listing/index.md diff --git a/docs/moderator/allow_listing/remove.md b/docs/moderator/allow-listing/remove.md similarity index 100% rename from docs/moderator/allow_listing/remove.md rename to docs/moderator/allow-listing/remove.md diff --git a/docs/moderator/external_users/index.md b/docs/moderator/external-users/index.md similarity index 100% rename from docs/moderator/external_users/index.md rename to docs/moderator/external-users/index.md diff --git a/docs/moderator/external_users/purge.md b/docs/moderator/external-users/purge.md similarity index 100% rename from docs/moderator/external_users/purge.md rename to docs/moderator/external-users/purge.md diff --git a/docs/moderator/external_users/rules/add.md b/docs/moderator/external-users/rules/add.md similarity index 100% rename from docs/moderator/external_users/rules/add.md rename to docs/moderator/external-users/rules/add.md diff --git a/docs/moderator/external_users/rules/delete.md b/docs/moderator/external-users/rules/delete.md similarity index 100% rename from docs/moderator/external_users/rules/delete.md rename to docs/moderator/external-users/rules/delete.md diff --git a/docs/moderator/external_users/rules/edit.md b/docs/moderator/external-users/rules/edit.md similarity index 100% rename from docs/moderator/external_users/rules/edit.md rename to docs/moderator/external-users/rules/edit.md diff --git a/docs/moderator/index.md b/docs/moderator/index.md index d7afbdc0f..28cd29db5 100644 --- a/docs/moderator/index.md +++ b/docs/moderator/index.md @@ -17,7 +17,7 @@ One of the most important duties of a moderator is handling reports. If a user f ## Moderate your pod's users -As a moderator, you are responsible for moderating the behavior of users on your pod. Funkwhale provides you with tools to help you handle users that violate your pod's rules. Check out our [Moderate your pod's users](internal_users/index.md) section for more information. +As a moderator, you are responsible for moderating the behavior of users on your pod. Funkwhale provides you with tools to help you handle users that violate your pod's rules. Check out our [Moderate your pod's users](internal-users/index.md) section for more information. ## Moderate content on your pod @@ -29,8 +29,8 @@ As {term}`fediverse` software, Funkwhale interacts with other software over fede ## Moderate external users -You can moderate how external users interact with users on your pod. Check out the [Moderate external users](external_users/index.md) guides to learn how to manage users from other servers. +You can moderate how external users interact with users on your pod. Check out the [Moderate external users](external-users/index.md) guides to learn how to manage users from other servers. ## Manage your allow-list -If your pod admin has set up allow-listing, you can add and remove domains from your pod's list. Follow the guides in the [Allow-listing](allow_listing/index.md) section to learn how to handle your allow-list. +If your pod admin has set up allow-listing, you can add and remove domains from your pod's list. Follow the guides in the [Allow-listing](allow-listing/index.md) section to learn how to handle your allow-list. diff --git a/docs/moderator/internal_users/index.md b/docs/moderator/internal-users/index.md similarity index 100% rename from docs/moderator/internal_users/index.md rename to docs/moderator/internal-users/index.md diff --git a/docs/moderator/internal_users/registration.md b/docs/moderator/internal-users/registration.md similarity index 100% rename from docs/moderator/internal_users/registration.md rename to docs/moderator/internal-users/registration.md diff --git a/docs/redirects.txt b/docs/redirects.txt index 673f5908a..884450702 100644 --- a/docs/redirects.txt +++ b/docs/redirects.txt @@ -19,7 +19,7 @@ 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 +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 @@ -37,7 +37,7 @@ 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/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