sign example config tweaks

Author: adorton-adobe

examples/sign/connector-sign.yml

@@ -1,19 +1,18 @@
-# To fetch below information do login to Sign console then click on Adobe Sign API tab
-# in API information tab click on Integration Key to 'Create integration key' after selecting appropriate 'scope'
+# This is the Sign connector config file template
+# For more information, see https://adobe-apiplatform.github.io/user-sync.py/en/user-manual/sign_sync.html#sign-connector-config
+
+# --- API Access Options ---
+# Options to configure Sign API access
+# See https://adobe-apiplatform.github.io/user-sync.py/en/user-manual/sign_sync.html#sign-connector-config
 host: api.echosign.com
 integration_key: [Sign API Key]
 admin_email: user@example.com
-# Flag to (dis)allow creation of new users in the Sign Neptune Console
+
+# --- Target-specific Behavior Options ---
+# Options to govern target behavior
 create_users: False
-# Flag to (dis)allow deactivation of users in the Sign Neptune Console
 deactivate_users: False
 
-# (optional) You can store credentials in the operating system credential store
-# (Windows Credential Manager, Mac Keychain, Linux Freedesktop Secret Service
-# or KWallet - these will be built into the Linux distribution).
-# To use this feature, uncomment the following entry and remove the
-# key entry above.
-# The actual credential value are placed in the credential store with the
-# username as the admin_email field value, and the key name (perhaps called internet
-# or network address) as the value below.
+# Instead of storing API key in plaintext, store in OS credential keychain
+# See https://adobe-apiplatform.github.io/user-sync.py/en/user-manual/sign_sync.html#securing-the-api-key
 #secure_integration_key_key: sign_key

examples/sign/sign-sync-config.yml

@@ -1,9 +1,13 @@
-# Sign API Connections
+# This is a template of the main Sign Sync config file
+# Full documentation here - https://adobe-apiplatform.github.io/user-sync.py/en/user-manual/sign_sync.html
+
+# --- Sign Connector Options ---
 sign_orgs:
+  # main connection should have "primary" key
   primary: connector-sign.yml
-  # Additional Sign Connection configuration files
+  # Additional Sign Connection configuration files (can have any name other than "primary")
   #secondary: connector-sign-sec.yml
-  #tertiary: connector-sign-ter.yml
+  #conection3: connector-sign-ter.yml
 
 # Similar to "directory_users.connectors" in user-sync-config.yml
 identity_source:
@@ -59,10 +63,8 @@ logging:
   file_log_level: info
   console_log_level: debug
 
-# Defaults for options that can be passed as CLI options
+# Invocation defaults - these work similarly to those found in the main UMAPI config
+# they provide default options that can be overridden in the command line
 invocation_defaults:
   users: mapped
-# test_mode presents post_sync output without performing any updates of users or user groups to the Sign Dashboard
-# test_mode possible values are yes or no. (default no)
-# test_mode is independent of user_sync test mode.
   test_mode: False