Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Quarto tweaks #800

Merged
merged 2 commits into from
Oct 9, 2023
Merged

Quarto tweaks #800

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3245f8b
minor tweaks from getting started
bjchambers Oct 9, 2023
15e54f3
docs: Add community page
bjchambers Oct 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 1 addition & 2 deletions python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ nox
* Generate reference docs

```shell
nox -s gen-docs
nox -s docs-gen
bjchambers marked this conversation as resolved.
Show resolved Hide resolved
```

You should re-run this after making any updates to the `pysrc` docstrings.
Expand All @@ -71,4 +71,3 @@ nox
```

This is primarily used in CI.

5 changes: 5 additions & 0 deletions python/docs/_quarto.yml
View file
Open in desktop
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
View file
Open in desktop

This file was deleted.

Binary file removed python/docs/_static/fonts/FontAwesome6Free-Solid-900.ttf
View file
Open in desktop
Binary file not shown.
Binary file removed python/docs/_static/fonts/FontAwesome6Free-Solid-900.woff2
View file
Open in desktop
Binary file not shown.
9 changes: 8 additions & 1 deletion python/docs/_templates/card.ejs
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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
8 changes: 8 additions & 0 deletions python/noxfile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,10 @@ def docs_gen(session: nox.Session) -> None:
@nox.session(python=python_versions[0])
def docs(session: nox.Session) -> None:
"""Build and serve the documentation with live reloading on file changes."""
if not shutil.which("quarto"):
session.error("Unable to execute `quarto`. Is it installed and in your path?\n"
"See https://quarto.org/docs/get-started/")

install(session, groups=["docs"])

with session.chdir("docs"):
Expand All @@ -149,6 +153,10 @@ def docs(session: nox.Session) -> None:
@nox.session(name="docs-build", python=python_versions[0])
def docs_build(session: nox.Session) -> None:
"""Build the docs."""
if not shutil.which("quarto"):
session.error("Unable to execute `quarto`. Is it installed and in your path?\n"
"See https://quarto.org/docs/get-started/")

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i wish nox had a way to call other nox commands before. like dependency running this one first. so we could avoid duplication like this.

it has a way to run other nox commands afterwards, but not before.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. I like that it lets us write Python to check things -- makes it easy for cases like this. I like that it makes it easy to run all python versions using virtualenvs. I'm watching wntrblm/nox#453 for dependency support (would be awesome to only build the maturin extension once, for instance).

It looks like https://github.com/rmorshea/noxopt#noxopt may be worth keeping an eye on too -- it would let us register a setup method for a prefix of the commands.

install(session, groups=["docs"])

with session.chdir("docs"):
Expand Down