docs(Slack): add Slack home screenshot (#68)

* add slack bot screenshot * docs(Slack): add screenshot to Readme, Slack integration * chore(ci): lock actions versions --------- Co-authored-by: Gabriel Dugny <[email protected]>
ManoManoTech · Jun 21, 2024 · fee864e · fee864e
1 parent 42a6a24
commit fee864e
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 5 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -63,10 +63,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Setup PDM
-        uses: pdm-project/setup-pdm@main
+        uses: pdm-project/setup-pdm@v3
         id: setup-pdm
         with:
           python-version: ${{ matrix.python-version }}
+          version: "2.12.4"
           cache: true
           allow-python-prereleases: true
 

diff --git a/README.md b/README.md
@@ -6,6 +6,8 @@ FireFighter is ManoMano's in-house Incident Management Tool.
 
 It helps manage incidents, by automatically creating a Slack channel for communication, and much more.
 
+![Slack Bot Commands](docs/assets/screenshots/slack_bot_home.jpeg)
+
 __What's Incident Management?__
 
 Incident Management is a set of processes and tools to help teams detect, respond to, and resolve incidents quickly and effectively.

diff --git a/docs/assets/screenshots/slack_bot_home.jpeg b/docs/assets/screenshots/slack_bot_home.jpeg
diff --git a/docs/index.md b/docs/index.md
@@ -1,6 +1,6 @@
 {%
    include-markdown "../README.md"
-   rewrite-relative-urls=false
+   rewrite-relative-urls=true
    end="<!--intro-end-->"
 %}
 
@@ -14,9 +14,7 @@
 
     Don't leave Slack to manage incidents, and keep your team in the loop.
 
-    <!-- [:octicons-arrow-right-24: Slack App](#) -->
-
-    <!-- [:octicons-arrow-right-24: Getting started](#) -->
+    [:octicons-arrow-right-24: Learn more](usage/integrations.md#slack)
 
 -   :simple-pagerduty:{ .lg .middle }  __Forward to PagerDuty__ _(optional)_
 

diff --git a/docs/usage/integrations.md b/docs/usage/integrations.md
@@ -38,6 +38,13 @@ No Back-Office configuration.
 
 ## :fontawesome-brands-slack: Slack
 
+### Features
+
+Open, manage and close incidents from Slack. The whole lifecycle.
+
+![See current incidents from Slack](../assets/screenshots/slack_bot_home.jpeg)
+_See current incidents from Slack._
+
 ### Tasks
 
 Tasks are provided to regularly sync users, conversations, usergroups and channel members from Slack.