Small updates to the about command and data collection pages

Kord-Extensions · Aug 18, 2024 · 5e980dc · 5e980dc
1 parent e0a0a66
commit 5e980dc
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/Writerside/topics/Data-Collection.topic b/Writerside/topics/Data-Collection.topic
@@ -220,6 +220,28 @@
 
     <chapter title="Configuration" id="config">
         <chapter title="Storage" id="config-storage">
+            <tip>
+                <p>
+                    If you're working in a containerized environment, or you otherwise absolutely cannot store the
+                    required state, you can still participate:
+                </p>
+
+                <list type="decimal">
+                    <li>
+                        Generate a version 4 UUID, either directly using Java/Kotlin or via
+                        <a href="https://fusionauth.io/dev-tools/uuid-generator">a website like this one</a>.
+                    </li>
+
+                    <li>
+                        Set the <code>dataCollectionUUID</code> system property or the
+                        <code>DATA_COLLECTION_UUID</code> environmental variable to the UUID at runtime.
+                    </li>
+                </list>
+
+                <p>
+                    <format style="bold">Please ensure that each instance of your bot has a unique UUID!</format>
+                </p>
+            </tip>
             <p>
                 Your bot needs to store some information relating to data collection for it to function
                 properly:

diff --git a/Writerside/topics/core/configuration/Config-About.topic b/Writerside/topics/core/configuration/Config-About.topic
@@ -81,6 +81,17 @@
                 </td>
             </tr>
 
+            <tr>
+                <td><code>Field</code></td>
+                <td><code>Field</code></td>
+
+                <td>
+                    <p>
+                        Add a field to be displayed in your bot's general information embed.
+                    </p>
+                </td>
+            </tr>
+
             <tr>
                 <td><code>section</code></td>
                 <td><code>Section</code></td>
@@ -102,6 +113,11 @@
                         Sections must also have a <code>message</code> builder, provided by calling the corresponding
                         builder function.
                     </p>
+
+                    <p>
+                        You may set the <code>ephemeral</code> property to decide whether the bot should respond
+                        ephemerally or not.
+                    </p>
                 </td>
             </tr>
         </table>
@@ -190,6 +206,16 @@
                 </td>
             </tr>
 
+            <tr>
+                <td><code>ephemeral</code></td>
+                <td><code>String</code></td>
+
+                <td>
+                    Whether to respond ephemerally when the about command is run.
+                    Defaults to <code>true</code>.
+                </td>
+            </tr>
+
             <tr>
                 <td><code>logoUrl</code></td>
                 <td><code>String</code></td>