update type docstrings

Author: jay7x

templates/gitlab_application_settings_type.erb

@@ -7,20 +7,37 @@ Puppet::ResourceApi.register_type(
   docs: <<~EOS,
     @summary Manage Gitlab settings
 
-    @example Manage settings
-      gitlab_settings { 'gitlab':
-        signup_enabled => false,
-        usage_ping_enabled => false,
-        version_check_enabled => false,
-      }
-
     This resource type provides Puppet with the capabilities to manage Gitlab
     settings via REST API. The only allowed resource title is 'gitlab'. It'll
     throw an error if any other title is specified.
 
-    @note Changes to your application settings are subject to caching and might
-    not immediately take effect. By default, GitLab caches application settings
-    for 60 seconds.
+    Gitlab API URL and token are required to use this type. There are two options:
+
+    1. Export those as GITLAB_BASE_URL and GITLAB_TOKEN environment variables.
+
+    2. Store those in a JSON file (see below) and export its location as
+    GITLAB_PROVIDER_CONFIG_PATH environment variable.
+
+    If none of above is made, it'll try to load configuration from /etc/puppetlabs/gitlab_provider.json file.
+
+    If still no luck, it'll throw an exception.
+
+    Configuration file format is as follows:
+    ```json
+    {
+      "base_url": "http://gitlab.example.com/api/v4",
+      "token": "<your_gitlab_token>"
+    }
+    ```
+
+    @note Changes to the application settings are subject to caching (60s default).
+
+    @example Manage Gitlab settings
+      gitlab_application_settings { 'gitlab':
+        signup_enabled => false,
+        usage_ping_enabled => false,
+        version_check_enabled => false,
+      }
 
     @see https://docs.gitlab.com/api/settings/
   EOS