update documentation

gardener · Aug 13, 2024 · fad6318 · fad6318
1 parent 2e87d06
commit fad6318
Show file tree

Hide file tree

Showing 5 changed files with 47 additions and 6 deletions.
diff --git a/_sources/traits/notifications.rst.txt b/_sources/traits/notifications.rst.txt
@@ -27,5 +27,10 @@ Example
                    - committers
                    - component_diff_owners
                    - codeowners
+                   slack:
+                       channel_cfgs:
+                         - channel_names: 
+                           - 'my_slack_channel'
+                           slack_cfg_name: 'my_slack_cfg_name'
                    inputs:
                    - component_descriptor_dir
diff --git a/_sources/traits/slack.rst.txt b/_sources/traits/slack.rst.txt
@@ -19,4 +19,4 @@ Example
     slack:
       channel_cfgs:
       - channel_name: 'my_slack_channel'
-        slack_cfg_name: 'scp_workspace' # see cc-config repository
+        slack_cfg_name: 'my_slack_cfg_name'
diff --git a/searchindex.js b/searchindex.js
diff --git a/traits/notifications.html b/traits/notifications.html
@@ -199,6 +199,12 @@ <h2>default.on_error <em>(NotificationCfg)</em> Attributes<a class="headerlink"
 </ul>
 </p></td>
 </tr>
+<tr class="row-odd"><td><p>slack</p></td>
+<td><p>no</p></td>
+<td><p>None</p></td>
+<td><p>NotificationSlack</p></td>
+<td><p>send notification via Slack</p></td>
+</tr>
 </tbody>
 </table>
 <h2>default.on_error.triggering_policy Enumeration Values<a class="headerlink" href="#trait-notifications" title="Link to this heading"></a></h2>
@@ -229,9 +235,6 @@ <h2>default.on_error.recipients Enumeration Values<a class="headerlink" href="#t
 </thead>
 <tbody>
 <tr class="row-even"><td><p>email_addresses</p></td>
-<td><p>notify committers of the last commit</p></td>
-</tr>
-<tr class="row-odd"><td><p>committers</p></td>
 <td><p><blockquote>
 <div><p>notifiy specific email addresses</p>
 <p>Example:</p>
@@ -244,6 +247,9 @@ <h2>default.on_error.recipients Enumeration Values<a class="headerlink" href="#t
 </div></blockquote>
 </p></td>
 </tr>
+<tr class="row-odd"><td><p>committers</p></td>
+<td><p>notify committers of the last commit</p></td>
+</tr>
 <tr class="row-even"><td><p>component_diff_owners</p></td>
 <td><p>notify the codeowners of a component. CODEOWNERS file must exist</p></td>
 </tr>
@@ -252,6 +258,31 @@ <h2>default.on_error.recipients Enumeration Values<a class="headerlink" href="#t
 </tr>
 </tbody>
 </table>
+<h2>default.on_error.slack Enumeration Values<a class="headerlink" href="#trait-notifications" title="Link to this heading"></a></h2>
+<table class="docutils align-default">
+<thead>
+<tr class="row-odd"><th class="head"><p>value</p></th>
+<th class="head"><p>explanation</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>channel_cfgs</p></td>
+<td><p><blockquote>
+<div><p>the slack channel configurations to use</p>
+<p>Example:</p>
+<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">slack</span><span class="p">:</span>
+<span class="w">  </span><span class="nt">channel_cfgs</span><span class="p">:</span>
+<span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">channel_names</span><span class="p">:</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;my_slack_channel&#39;</span>
+<span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;my_other_slack_channel&#39;</span>
+<span class="w">    </span><span class="nt">slack_cfg_name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;my_slack_cfg_name&#39;</span>
+</pre></div>
+</div>
+</div></blockquote>
+</p></td>
+</tr>
+</tbody>
+</table>
 <h2>Dependencies<a class="headerlink" href="#trait-notifications" title="Link to this heading"></a></h2>
 <p>This trait has <em>no</em> dependencies</p>
 </section>
@@ -269,6 +300,11 @@ <h2>Example<a class="headerlink" href="#example" title="Link to this heading">
 <span class="w">                </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">committers</span>
 <span class="w">                </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">component_diff_owners</span>
 <span class="w">                </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">codeowners</span>
+<span class="w">                </span><span class="nt">slack</span><span class="p">:</span>
+<span class="w">                    </span><span class="nt">channel_cfgs</span><span class="p">:</span>
+<span class="w">                      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">channel_names</span><span class="p">:</span>
+<span class="w">                        </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="s">&#39;my_slack_channel&#39;</span>
+<span class="w">                        </span><span class="nt">slack_cfg_name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;my_slack_cfg_name&#39;</span>
 <span class="w">                </span><span class="nt">inputs</span><span class="p">:</span>
 <span class="w">                </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">component_descriptor_dir</span>
 </pre></div>

diff --git a/traits/slack.html b/traits/slack.html
@@ -139,7 +139,7 @@ <h2>Example<a class="headerlink" href="#example" title="Link to this heading">
 <span class="w">  </span><span class="nt">slack</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">channel_cfgs</span><span class="p">:</span>
 <span class="w">    </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">channel_name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;my_slack_channel&#39;</span>
-<span class="w">      </span><span class="nt">slack_cfg_name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;scp_workspace&#39;</span><span class="w"> </span><span class="c1"># see cc-config repository</span>
+<span class="w">      </span><span class="nt">slack_cfg_name</span><span class="p">:</span><span class="w"> </span><span class="s">&#39;my_slack_cfg_name&#39;</span>
 </pre></div>
 </div>
 </section>