add Mattermost linking mechanism

This closes issue #61 on GitHub.
canonical · Nov 22, 2023 · 68c3177 · 68c3177
1 parent a2d2061
commit 68c3177
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/.sphinx/_templates/footer.html b/.sphinx/_templates/footer.html
@@ -80,6 +80,12 @@
     </div>
     {% endif %}
 
+    {% if mattermost %}
+    <div class="ask-mattermost">
+      <a class="muted-link" href="{{ mattermost }}">Ask a question on Mattermost</a>
+    </div>
+    {% endif %}
+
     {% if github_url and github_version and github_folder %}
 
     {% if github_issues %}

diff --git a/.wordlist.txt b/.wordlist.txt
@@ -18,6 +18,7 @@ Juju
 Kubernetes
 Kubeflow
 Makefile
+Mattermost
 MyST
 namespace
 namespaces

diff --git a/custom_conf.py b/custom_conf.py
@@ -77,6 +77,10 @@
     # (use an empty value if you don't want to link)
     'discourse': 'https://discourse.ubuntu.com',
 
+    # Change to the Mattermost channel you want to link to
+    # (use an empty value if you don't want to link)
+    'mattermost': 'https://chat.canonical.com/canonical/channels/documentation',
+
     # Change to the GitHub URL for your project
     'github_url': 'https://github.com/canonical/starter-pack',