From e7619fd189f53206aa908bdf20d6e9841cb58d17 Mon Sep 17 00:00:00 2001
From: Eliot Berriot <contact@eliotberriot.com>
Date: Thu, 17 May 2018 23:40:06 +0200
Subject: [PATCH] See #206: minor tweaks on settings (wording, input type...)
---
.../common/dynamic_preferences_registry.py | 2 +-
.../dynamic_preferences_registry.py | 17 ++++--
.../instance/dynamic_preferences_registry.py | 52 +++++++++++--------
.../playlists/dynamic_preferences_registry.py | 3 ++
.../acoustid/dynamic_preferences_registry.py | 6 +++
.../youtube/dynamic_preferences_registry.py | 6 +++
.../users/dynamic_preferences_registry.py | 5 +-
7 files changed, 61 insertions(+), 30 deletions(-)
diff --git a/api/funkwhale_api/common/dynamic_preferences_registry.py b/api/funkwhale_api/common/dynamic_preferences_registry.py
index 2374de7c..15b18267 100644
--- a/api/funkwhale_api/common/dynamic_preferences_registry.py
+++ b/api/funkwhale_api/common/dynamic_preferences_registry.py
@@ -16,5 +16,5 @@ class APIAutenticationRequired(
help_text = (
'If disabled, anonymous users will be able to query the API'
'and access music data (as well as other data exposed in the API '
- 'without specific permissions)'
+ 'without specific permissions).'
)
diff --git a/api/funkwhale_api/federation/dynamic_preferences_registry.py b/api/funkwhale_api/federation/dynamic_preferences_registry.py
index e86b9f6f..8b1b2b03 100644
--- a/api/funkwhale_api/federation/dynamic_preferences_registry.py
+++ b/api/funkwhale_api/federation/dynamic_preferences_registry.py
@@ -19,6 +19,9 @@ class MusicCacheDuration(types.IntPreference):
'locally? Federated files that were not listened in this interval '
'will be erased and refetched from the remote on the next listening.'
)
+ field_kwargs = {
+ 'required': False,
+ }
@global_preferences_registry.register
@@ -29,7 +32,7 @@ class Enabled(preferences.DefaultFromSettingMixin, types.BooleanPreference):
verbose_name = 'Federation enabled'
help_text = (
'Use this setting to enable or disable federation logic and API'
- ' globally'
+ ' globally.'
)
@@ -41,8 +44,11 @@ class CollectionPageSize(
setting = 'FEDERATION_COLLECTION_PAGE_SIZE'
verbose_name = 'Federation collection page size'
help_text = (
- 'How much items to display in ActivityPub collections'
+ 'How much items to display in ActivityPub collections.'
)
+ field_kwargs = {
+ 'required': False,
+ }
@global_preferences_registry.register
@@ -54,8 +60,11 @@ class ActorFetchDelay(
verbose_name = 'Federation actor fetch delay'
help_text = (
'How much minutes to wait before refetching actors on '
- 'request authentication'
+ 'request authentication.'
)
+ field_kwargs = {
+ 'required': False,
+ }
@global_preferences_registry.register
@@ -66,6 +75,6 @@ class MusicNeedsApproval(
setting = 'FEDERATION_MUSIC_NEEDS_APPROVAL'
verbose_name = 'Federation music needs approval'
help_text = (
- 'When true, other federation actors will require your approval'
+ 'When true, other federation actors will need your approval'
' before being able to browse your library.'
)
diff --git a/api/funkwhale_api/instance/dynamic_preferences_registry.py b/api/funkwhale_api/instance/dynamic_preferences_registry.py
index 20679fd3..8ccf80dd 100644
--- a/api/funkwhale_api/instance/dynamic_preferences_registry.py
+++ b/api/funkwhale_api/instance/dynamic_preferences_registry.py
@@ -13,8 +13,11 @@ class InstanceName(types.StringPreference):
section = instance
name = 'name'
default = ''
- help_text = 'Instance public name'
- verbose_name = 'The public name of your instance'
+ verbose_name = 'Public name'
+ help_text = 'The public name of your instance, displayed in the about page.'
+ field_kwargs = {
+ 'required': False,
+ }
@global_preferences_registry.register
@@ -23,7 +26,11 @@ class InstanceShortDescription(types.StringPreference):
section = instance
name = 'short_description'
default = ''
- verbose_name = 'Instance succinct description'
+ verbose_name = 'Short description'
+ help_text = 'Instance succinct description, displayed in the about page.'
+ field_kwargs = {
+ 'required': False,
+ }
@global_preferences_registry.register
@@ -31,31 +38,31 @@ class InstanceLongDescription(types.StringPreference):
show_in_api = True
section = instance
name = 'long_description'
+ verbose_name = 'Long description'
default = ''
- help_text = 'Instance long description (markdown allowed)'
+ help_text = 'Instance long description, displayed in the about page (markdown allowed).'
+ widget = widgets.Textarea
field_kwargs = {
- 'widget': widgets.Textarea
+ 'required': False,
}
+
@global_preferences_registry.register
class RavenDSN(types.StringPreference):
show_in_api = True
section = raven
name = 'front_dsn'
default = 'https://9e0562d46b09442bb8f6844e50cbca2b@sentry.eliotberriot.com/4'
- verbose_name = (
- 'A raven DSN key used to report front-ent errors to '
- 'a sentry instance'
- )
+ verbose_name = 'Raven DSN key (front-end)'
+
help_text = (
- 'Keeping the default one will report errors to funkwhale developers'
+ 'A Raven DSN key used to report front-ent errors to '
+ 'a sentry instance. Keeping the default one will report errors to '
+ 'Funkwhale developers.'
)
-
-
-SENTRY_HELP_TEXT = (
- 'Error reporting is disabled by default but you can enable it if'
- ' you want to help us improve funkwhale'
-)
+ field_kwargs = {
+ 'required': False,
+ }
@global_preferences_registry.register
@@ -65,8 +72,7 @@ class RavenEnabled(types.BooleanPreference):
name = 'front_enabled'
default = False
verbose_name = (
- 'Wether error reporting to a Sentry instance using raven is enabled'
- ' for front-end errors'
+ 'Report front-end errors with Raven'
)
@@ -78,7 +84,7 @@ class InstanceNodeinfoEnabled(types.BooleanPreference):
default = True
verbose_name = 'Enable nodeinfo endpoint'
help_text = (
- 'This endpoint is needed for your about page to work.'
+ 'This endpoint is needed for your about page to work. '
'It\'s also helpful for the various monitoring '
'tools that map and analyzize the fediverse, '
'but you can disable it completely if needed.'
@@ -91,10 +97,10 @@ class InstanceNodeinfoPrivate(types.BooleanPreference):
section = instance
name = 'nodeinfo_private'
default = False
- verbose_name = 'Enable nodeinfo endpoint'
+ verbose_name = 'Private mode in nodeinfo'
help_text = (
- 'Indicate in the nodeinfo endpoint that you do not want your instance'
- 'to be tracked by third-party services.'
+ 'Indicate in the nodeinfo endpoint that you do not want your instance '
+ 'to be tracked by third-party services. '
'There is no guarantee these tools will honor this setting though.'
)
@@ -107,6 +113,6 @@ class InstanceNodeinfoStatsEnabled(types.BooleanPreference):
default = True
verbose_name = 'Enable usage and library stats in nodeinfo endpoint'
help_text = (
- 'Disable this f you don\'t want to share usage and library statistics'
+ 'Disable this if you don\'t want to share usage and library statistics '
'in the nodeinfo endpoint but don\'t want to disable it completely.'
)
diff --git a/api/funkwhale_api/playlists/dynamic_preferences_registry.py b/api/funkwhale_api/playlists/dynamic_preferences_registry.py
index 21140fa1..b717177a 100644
--- a/api/funkwhale_api/playlists/dynamic_preferences_registry.py
+++ b/api/funkwhale_api/playlists/dynamic_preferences_registry.py
@@ -13,3 +13,6 @@ class MaxTracks(preferences.DefaultFromSettingMixin, types.IntegerPreference):
name = 'max_tracks'
verbose_name = 'Max tracks per playlist'
setting = 'PLAYLISTS_MAX_TRACKS'
+ field_kwargs = {
+ 'required': False,
+ }
diff --git a/api/funkwhale_api/providers/acoustid/dynamic_preferences_registry.py b/api/funkwhale_api/providers/acoustid/dynamic_preferences_registry.py
index da785df4..33c9643b 100644
--- a/api/funkwhale_api/providers/acoustid/dynamic_preferences_registry.py
+++ b/api/funkwhale_api/providers/acoustid/dynamic_preferences_registry.py
@@ -1,3 +1,5 @@
+from django import forms
+
from dynamic_preferences.types import StringPreference, Section
from dynamic_preferences.registries import global_preferences_registry
@@ -11,3 +13,7 @@ class APIKey(StringPreference):
default = ''
verbose_name = 'Acoustid API key'
help_text = 'The API key used to query AcoustID. Get one at https://acoustid.org/new-application.'
+ widget = forms.PasswordInput
+ field_kwargs = {
+ 'required': False,
+ }
diff --git a/api/funkwhale_api/providers/youtube/dynamic_preferences_registry.py b/api/funkwhale_api/providers/youtube/dynamic_preferences_registry.py
index fc7f7d79..ac5fc4bd 100644
--- a/api/funkwhale_api/providers/youtube/dynamic_preferences_registry.py
+++ b/api/funkwhale_api/providers/youtube/dynamic_preferences_registry.py
@@ -1,3 +1,5 @@
+from django import forms
+
from dynamic_preferences.types import StringPreference, Section
from dynamic_preferences.registries import global_preferences_registry
@@ -11,3 +13,7 @@ class APIKey(StringPreference):
default = 'CHANGEME'
verbose_name = 'YouTube API key'
help_text = 'The API key used to query YouTube. Get one at https://console.developers.google.com/.'
+ widget = forms.PasswordInput
+ field_kwargs = {
+ 'required': False,
+ }
diff --git a/api/funkwhale_api/users/dynamic_preferences_registry.py b/api/funkwhale_api/users/dynamic_preferences_registry.py
index 16d79da1..4f736053 100644
--- a/api/funkwhale_api/users/dynamic_preferences_registry.py
+++ b/api/funkwhale_api/users/dynamic_preferences_registry.py
@@ -10,6 +10,7 @@ class RegistrationEnabled(types.BooleanPreference):
section = users
name = 'registration_enabled'
default = False
- verbose_name = (
- 'Can visitors open a new account on this instance?'
+ verbose_name = 'Open registrations to new users'
+ help_text = (
+ 'When enabled, new users will be able to register on this instance.'
)
--
GitLab