Merge ~cjohnston/charm-prometheus2:doc-tweaks into charm-prometheus2:master

[Chris Johnston]

Clarify config description of rules-repo and rules-update-ssh-key.

Fixes: LP: #2018932, #2018933

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

This merge proposal is being monitored by mergebot. Change the status to Approved to merge.

[🤖 prod-jenkaas-bootstack (prod-jenkaas-bootstack)]

PASSED: Continuous integration, rev:660df4a7464c2de808cd706aaaf80a8504d607ec
https://jenkins.canonical.com/bootstack/job/lp-charm-prometheus2-ci/12/
Executed test runs:
    SUCCESS: https://jenkins.canonical.com/bootstack/job/lp-charm-test-functest/961/
    None: https://jenkins.canonical.com/bootstack/job/lp-update-mp/306/

Click here to trigger a rebuild:
https://jenkins.canonical.com/bootstack/job/lp-charm-prometheus2-ci/12//rebuild

review: Approve (continuous-integration)

[Eric Chen (eric-chen)]

LGTM

review: Approve

[🤖 Canonical IS Merge Bot (canonical-is-mergebot)]

Change successfully merged at revision 4c824e138bdc0f7b03f5ff4e562e58c8e654db9b

diff --git a/src/config.yaml b/src/config.yaml
index cbfaf8d..01bd9e8 100644
--- a/src/config.yaml
+++ b/src/config.yaml
@@ -148,7 +148,7 @@ options:
   rules-repo:
     type: string
     description: |
-        Git repository with custom rules. Rules have to be in *.rules files
+        Git repository with custom rules. Rules have to be in *.yaml, *.yml, or *.rules files
     default: ""
   rules-repo-branch:
     type: string
@@ -166,6 +166,7 @@ options:
     type: string
     description: |
         Plain text private SSH key used to for git authentication.
+        Example: juju config prometheus2 rules-update-ssh-key=@private_ssh_key_file
         Also see "rules-repo" config option
     default: ""
   rules-update-notify-email: