chore(docs): Note the 140-character limit for SMS messages

morningconsult · Jun 19, 2019 · 17b455b · 17b455b
1 parent 2f702d2
commit 17b455b
Show file tree

Hide file tree

Showing 11 changed files with 14 additions and 3 deletions.
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/user/demo.doctree b/docs/build/doctrees/user/demo.doctree
diff --git a/docs/build/doctrees/user/install.doctree b/docs/build/doctrees/user/install.doctree
diff --git a/docs/build/doctrees/user/intro.doctree b/docs/build/doctrees/user/intro.doctree
diff --git a/docs/build/doctrees/user/setup.doctree b/docs/build/doctrees/user/setup.doctree
diff --git a/docs/build/doctrees/user/usage.doctree b/docs/build/doctrees/user/usage.doctree
diff --git a/docs/build/html/_sources/user/setup.txt b/docs/build/html/_sources/user/setup.txt
@@ -362,11 +362,15 @@ AWS SNS Output Parameters
 - :code-no-background:`template` (string: ``""``) - The message template that will
  define what alert messages will look like. This template is based on `Go templates
  <https://golang.org/pkg/text/template/>`__. It allows you to interpolate an array
- of `alert records 
+ of `alert records
  <https://godoc.org/github.com/morningconsult/go-elasticsearch-alerts/command/alert#Record>`__ 
  into the template to expose custom message formatting for your alerts. This field is
  required.
 
+**IMPORTANT**: If sending SMS messages with your SMS topic, a strict 140-character
+limit is enforced. Please take this into consideration when writing your message
+template.
+
 As an example, let's say you have this output method in one of your rule files:
 
 .. code-block:: json

diff --git a/docs/build/html/searchindex.js b/docs/build/html/searchindex.js
diff --git a/docs/build/html/user/setup.html b/docs/build/html/user/setup.html
@@ -380,6 +380,9 @@ <h3>AWS SNS Output Parameters<a class="headerlink" href="#aws-sns-output-paramet
 into the template to expose custom message formatting for your alerts. This field is
 required.</li>
 </ul>
+<p><strong>IMPORTANT</strong>: If sending SMS messages with your SMS topic, a strict 140-character
+limit is enforced. Please take this into consideration when writing your message
+template.</p>
 <p>As an example, let&#8217;s say you have this output method in one of your rule files:</p>
 <div class="highlight-json"><div class="highlight"><pre>{
  &quot;name&quot;: &quot;Filebeat Errors&quot;,

diff --git a/docs/user/setup.rst b/docs/user/setup.rst
@@ -362,11 +362,15 @@ AWS SNS Output Parameters
 - :code-no-background:`template` (string: ``""``) - The message template that will
  define what alert messages will look like. This template is based on `Go templates
  <https://golang.org/pkg/text/template/>`__. It allows you to interpolate an array
- of `alert records 
+ of `alert records
  <https://godoc.org/github.com/morningconsult/go-elasticsearch-alerts/command/alert#Record>`__ 
  into the template to expose custom message formatting for your alerts. This field is
  required.
 
+**IMPORTANT**: If sending SMS messages with your SMS topic, a strict 140-character
+limit is enforced. Please take this into consideration when writing your message
+template.
+
 As an example, let's say you have this output method in one of your rule files:
 
 .. code-block:: json