From 69467c006e502142308cd4ab8499075309ec2c07 Mon Sep 17 00:00:00 2001 From: Willy Kloucek Date: Mon, 27 Jun 2022 09:08:13 +0200 Subject: [PATCH] improve descriptions --- docs/extensions/ocdav/_index.md | 1 + docs/extensions/webdav/_index.md | 3 +-- extensions/settings/pkg/config/config.go | 2 +- extensions/settings/pkg/config/http.go | 2 +- extensions/sharing/pkg/config/config.go | 4 ++-- extensions/web/pkg/config/config.go | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/extensions/ocdav/_index.md b/docs/extensions/ocdav/_index.md index 62f55ff1b5..88bd6382fc 100644 --- a/docs/extensions/ocdav/_index.md +++ b/docs/extensions/ocdav/_index.md @@ -9,6 +9,7 @@ geekdocCollapseSection: true --- ## Abstract +This service provides the WebDAV API which is required by ownCloud clients. Previews (thumbnails) are provided by the [WebDAV service]({{ ../../webdav }}). ## Table of Contents diff --git a/docs/extensions/webdav/_index.md b/docs/extensions/webdav/_index.md index fff42eb9b4..7c1e082ae5 100644 --- a/docs/extensions/webdav/_index.md +++ b/docs/extensions/webdav/_index.md @@ -10,8 +10,7 @@ geekdocCollapseSection: true ## Abstract -This service provides the WebDAV API which is required by some ownCloud clients. - +This service provides preview (thumbnails) endpoints on the WebDAV API and therefore extends the main WebDAV API provided by the [oCDAV service]({{ ../../ocdav }}). ## Table of Contents diff --git a/extensions/settings/pkg/config/config.go b/extensions/settings/pkg/config/config.go index de7570cb16..772aaf554b 100644 --- a/extensions/settings/pkg/config/config.go +++ b/extensions/settings/pkg/config/config.go @@ -35,7 +35,7 @@ type Config struct { // Asset defines the available asset configuration. type Asset struct { - Path string `yaml:"path" env:"SETTINGS_ASSET_PATH" desc:"Serve settings assets from a path on the filesystem instead of the builtin assets."` + Path string `yaml:"path" env:"SETTINGS_ASSET_PATH" desc:"Serve settings Web UI assets from a path on the filesystem instead of the builtin assets. Can be used for development and customization."` } // Metadata configures the metadata store to use diff --git a/extensions/settings/pkg/config/http.go b/extensions/settings/pkg/config/http.go index 5c61c90683..f436e45711 100644 --- a/extensions/settings/pkg/config/http.go +++ b/extensions/settings/pkg/config/http.go @@ -5,7 +5,7 @@ type HTTP struct { Addr string `yaml:"addr" env:"SETTINGS_HTTP_ADDR" desc:"The bind address of the HTTP service."` Namespace string `yaml:"-"` Root string `yaml:"root" env:"SETTINGS_HTTP_ROOT" desc:"The root path of the HTTP service."` - CacheTTL int `yaml:"cache_ttl" env:"SETTINGS_CACHE_TTL" desc:"Cache TTL policy."` + CacheTTL int `yaml:"cache_ttl" env:"SETTINGS_CACHE_TTL" desc:"Browser cache control max-age value in seconds for settings Web UI assets."` CORS CORS `yaml:"cors"` } diff --git a/extensions/sharing/pkg/config/config.go b/extensions/sharing/pkg/config/config.go index 6e9e3cd7a8..5d0d4452be 100644 --- a/extensions/sharing/pkg/config/config.go +++ b/extensions/sharing/pkg/config/config.go @@ -90,7 +90,7 @@ type UserSharingOwnCloudSQLDriver struct { DBHost string `yaml:"db_host" env:"SHARING_USER_OWNCLOUDSQL_DB_HOST" desc:"Hostname or IP of the database server."` DBPort int `yaml:"db_port" env:"SHARING_USER_OWNCLOUDSQL_DB_PORT" desc:"Port, the database server is listening on."` DBName string `yaml:"db_name" env:"SHARING_USER_OWNCLOUDSQL_DB_NAME" desc:"Name of the database to be used."` - UserStorageMountID string `yaml:"user_storage_mount_id" env:"SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID" desc:"Mount ID of this storage."` + UserStorageMountID string `yaml:"user_storage_mount_id" env:"SHARING_USER_OWNCLOUDSQL_USER_STORAGE_MOUNT_ID" desc:"Mount ID of the ownCloudSQL users storage for mapping ownCloud 10 shares."` } type UserSharingCS3Driver struct { @@ -108,7 +108,7 @@ type PublicSharingDrivers struct { } type PublicSharingJSONDriver struct { - File string `yaml:"file" env:"SHARING_PUBLIC_JSON_FILE" desc:"Path to the json file where public shares will be persisted."` + File string `yaml:"file" env:"SHARING_PUBLIC_JSON_FILE" desc:"Path to the JSON file where public share meta-data will be stored. This JSON file contains the information about public shares that have been created."` } type PublicSharingSQLDriver struct { diff --git a/extensions/web/pkg/config/config.go b/extensions/web/pkg/config/config.go index a25cb7abc2..cde6f8855c 100644 --- a/extensions/web/pkg/config/config.go +++ b/extensions/web/pkg/config/config.go @@ -71,7 +71,7 @@ type ExternalAppConfig struct { // Web defines the available web configuration. type Web struct { - Path string `yaml:"path" env:"WEB_UI_PATH" desc:"Read the ownCloud Web configuration from a file."` + Path string `yaml:"path" env:"WEB_UI_PATH" desc:"Read the ownCloud Web configuration from this file path."` ThemeServer string `yaml:"theme_server" env:"OCIS_URL;WEB_UI_THEME_SERVER" desc:"URL to load themes from. Will be prepended to the theme path."` // used to build Theme in WebConfig ThemePath string `yaml:"theme_path" env:"WEB_UI_THEME_PATH" desc:"URL path to load themes from. The theme server will be prepended."` // used to build Theme in WebConfig Config WebConfig `yaml:"config"`