Skip to content

Commit

Permalink
docs: Add community page
Browse files Browse the repository at this point in the history
Also:

- switch to using bootstrap icons over font awesome icons
- update card.ejs to allow for links
  • Loading branch information
bjchambers committed Oct 9, 2023
1 parent 3245f8b commit 15e54f3
Show file tree
Hide file tree
Showing 7 changed files with 67 additions and 43 deletions.
5 changes: 5 additions & 0 deletions python/docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -48,6 +50,9 @@ website:
- guide/execution.qmd
- title: Examples
contents: examples
- title: Community
contents:
- community/index.qmd
- title: API
style: docked
contents: reference
Expand Down
38 changes: 0 additions & 38 deletions python/docs/_static/css/root.css

This file was deleted.

Binary file not shown.
Binary file not shown.
9 changes: 8 additions & 1 deletion python/docs/_templates/card.ejs
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
<% } %>
Expand Down
51 changes: 51 additions & 0 deletions python/docs/community/index.qmd
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 3 additions & 4 deletions python/docs/index.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
---

Expand Down

0 comments on commit 15e54f3

Please sign in to comment.