taigrr/wtf
1
0
Fork 0
mirror of https://github.com/taigrr/wtf synced 2025-01-18 04:03:14 -08:00
Code Issues Projects Releases Wiki Activity

Generate the documentation for the new config changes

Browse Source
This commit is contained in:
Chris Cummer
2018-07-31 15:37:02 -07:00
parent b6036a3eae
commit da9b863625
10 changed files with 101 additions and 100 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/posts/modules/zendesk/index.html
View File

@@ -143,14 +143,6 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="source-code">Source Code</h2>
<div class="highlight"><pre class="chroma"><code class="language-bash" data-lang="bash">wtf/zendesk/</code></pre></div>
<h2 id="required-env-variables">Required ENV Variables</h2>
<p><span class="caption">Key:</span> <code>ZENDESK_API</code> <br />
<span class="caption">Value:</span> Your Zendesk API Token</p>
<p><span class="caption">Key:</span> <code>ZENDESK_DOMAIN</code> <br />
<span class="caption">Value:</span> Your Zendesk subdomain</p>
<h2 id="keyboard-commands">Keyboard Commands</h2>
<p><span class="caption">Key:</span> <code>[return]</code> <br />
@@ -170,6 +162,7 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
<h2 id="configuration">Configuration</h2>
<div class="highlight"><pre class="chroma"><code class="language-yaml" data-lang="yaml">zendesk<span class="p">:</span><span class="w">
</span><span class="w"> </span>apiKey<span class="p">:</span><span class="w"> </span><span class="s2">&#34;3276d7155dd9ee27b8b14f8743a408a9&#34;</span><span class="w">
</span><span class="w"> </span>enabled<span class="p">:</span><span class="w"> </span><span class="kc">true</span><span class="w">
</span><span class="w"> </span>position<span class="p">:</span><span class="w">
</span><span class="w"> </span>top<span class="p">:</span><span class="w"> </span><span class="m">0</span><span class="w">
@@ -177,9 +170,13 @@ height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
</span><span class="w"> </span>height<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>width<span class="p">:</span><span class="w"> </span><span class="m">1</span><span class="w">
</span><span class="w"> </span>status<span class="p">:</span><span class="w"> </span><span class="s2">&#34;new&#34;</span><span class="w">
</span><span class="w"> </span>subdomain<span class="p">:</span><span class="w"> </span><span class="s2">&#34;your_domain&#34;</span><span class="w">
</span><span class="w"> </span>username<span class="p">:</span><span class="w"> </span><span class="s2">&#34;your_email@acme.com&#34;</span></code></pre></div>
<h3 id="attributes">Attributes</h3>
<p><code>apiKey</code> <br />
Value: Your Zendesk API token.</p>
<p><code>enabled</code> <br />
Determines whether or not this module is executed and if its data displayed onscreen. <br />
Values: <code>true</code>, <code>false</code>.</p>
@@ -191,6 +188,9 @@ Defines where in the grid this module&rsquo;s widget will be displayed. <br /></
The status of tickets you want to retrieve.
Values: <code>new</code>, <code>open</code>, <code>pending</code>, <code>hold</code>.</p>
<p><code>subdomain</code> <br />
Value: Your Zendesk subdomain.</p>
<p><code>username</code> <br />
Your Zendesk username
Values: A valid Zendesk username (usually an email address).</p>