docs: Add community page

Also: - switch to using bootstrap icons over font awesome icons - update card.ejs to allow for links
kaskada-ai · Oct 9, 2023 · 15e54f3 · 15e54f3
1 parent 3245f8b
commit 15e54f3
Show file tree

Hide file tree

Showing 7 changed files with 67 additions and 43 deletions.
diff --git a/python/docs/_quarto.yml b/python/docs/_quarto.yml
@@ -21,6 +21,8 @@ website:
         text: User Guide
       - href: examples/index.qmd
         text: Examples
+      - href: community/index.qmd
+        text: Community
       - href: reference/index.qmd
         text: API
       - href: blog/index.qmd
@@ -48,6 +50,9 @@ website:
       - guide/execution.qmd
   - title: Examples
     contents: examples
+  - title: Community
+    contents:
+      - community/index.qmd
   - title: API
     style: docked
     contents: reference

diff --git a/python/docs/_static/css/root.css b/python/docs/_static/css/root.css
diff --git a/python/docs/_static/fonts/FontAwesome6Free-Solid-900.ttf b/python/docs/_static/fonts/FontAwesome6Free-Solid-900.ttf
diff --git a/python/docs/_static/fonts/FontAwesome6Free-Solid-900.woff2 b/python/docs/_static/fonts/FontAwesome6Free-Solid-900.woff2
diff --git a/python/docs/_templates/card.ejs b/python/docs/_templates/card.ejs
@@ -6,7 +6,7 @@
             <div class="sd-col sd-d-flex-row docutils">
                 <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils">
                     <div class="sd-card-header docutils">
-                        <p class="card-text"><i class="fas fa-<%= item.icon %> pst-color-primary"></i>
+                        <p class="card-text"><i class="<%= item.icon %>"></i>
                             <%= item.name %>
                         </p>
                     </div>
@@ -15,6 +15,13 @@
                             <%= item.content %>
                         </p>
                     </div>
+                    <% if (item.link) { %>
+                        <div class="sd-card-body">
+                            <a href="<%= item.link %>" class="card-link">
+                                <%= item.link_label %>
+                            </a>
+                        </div>
+                        <% } %>
                 </div>
             </div>
             <% } %>

diff --git a/python/docs/community/index.qmd b/python/docs/community/index.qmd
@@ -0,0 +1,51 @@
+---
+title: Community
+format:
+  html:
+    css:
+      - /_static/css/design-style.css
+    link-external-icon: true
+    link-external-newwindow: true
+
+listing:
+  - id: cards
+    template: ../_templates/card.ejs
+    contents:
+      - name: GitHub Discussions
+        icon: bi bi-github
+        content: Ask questions and discuss Kaskada on GitHub.
+        link: https://github.com/kaskada-ai/kaskada/discussions
+        link_label: See GitHub Discussions
+      - name: Slack
+        icon: bi bi-slack
+        content: Join us on Slack to chat about Proactive AI!
+        link: https://join.slack.com/t/kaskada-hq/shared_invite/zt-1t1lms085-bqs2jtGO2TYr9kuuam~c9w
+        link_label: Join Slack
+      - name: Office Hours
+        icon: bi bi-camera-video-fill
+        content:  Discuss your real-time Gen AI needs and ideas with us!
+        link: https://calendly.com/kaskada-io/office-hours
+        link_label: Schedule a video call
+---
+
+::: {#cards }
+:::
+
+Welcome to the Kaskada community!
+
+The Kaskada project was open-sourced in 2023. As a growing community, we're here to explore new ways to interact with event-based data at scale and have some fun along the way. We build in the open and use the channels below for communication.
+
+## Contributing
+
+Nothing makes us happier than community contributions. See the README in the main Kaskada repository to get a grasp of the project layout and reference the [`CONTRIBUTING.md`](https://github.com/kaskada-ai/kaskada/blob/main/CONTRIBUTING.md){target="_blank" rel="noopener noreferrer"} file for detailed steps.
+
+Use the [GitHub issue tracker](https://github.com/kaskada-ai/kaskada/issues) to file bugs and feature requests.
+
+Acceptance of the DataStax [contributor license agreement (CLA)](https://cla.datastax.com/) is required in order for us to be able to accept your code contribution. You will see this on the standard pull request checklist for the Kaskada repositories.
+
+If you're interested in contributing but don't know where to start, we also recommend looking for a good first issue in the main repository.
+
+## Code of Conduct
+
+To make Kaskada a welcoming and harassment-free experience for everyone, we adopt and follow the [Contributor Covenant](https://www.contributor-covenant.org/).
+Please read our [Code of Conduct](https://github.com/kaskada-ai/kaskada/blob/main/CODE_OF_CONDUCT.md) before engaging with the community.
diff --git a/python/docs/index.qmd b/python/docs/index.qmd
@@ -3,7 +3,6 @@ format:
   html:
     css:
       - _static/css/design-style.css
-      - _static/css/root.css
     link-external-icon: true
     link-external-newwindow: true
     toc: false
@@ -13,13 +12,13 @@ listing:
     template: _templates/card.ejs
     contents:
       - name: "Real-time Aggregation"
-        icon: timeline
+        icon: bi bi-clock-history
         content: Precompute model inputs from streaming data with robust data connectors, transformations & aggregations.
       - name: Event Detection
-        icon: binoculars
+        icon: bi bi-binoculars-fill
         content: Trigger pro-active AI behaviors by identifying important activities, as they happen.
       - name: History Replay
-        icon: backward
+        icon: bi bi-skip-backward-fill
         content: Backtest and fine-tune from historical data using per-example time travel and point-in-time joins.
 ---