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.

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

Update naming to be consistent #147

Merged
merged 2 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Contributing to Spice.ai Docs
# Contributing to Spice.ai OSS Docs

Thanks for contributing to making Spice.ai better!
Thanks for contributing to making Spice better!

## Writing style guide

We will add a Spice.ai specific style-guide in the future. Until then, we recommend you refer to the following guides:
We will add a Spice specific style-guide in the future. Until then, we recommend you refer to the following guides:

- Kubernetes [Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/)
- Google [developer documentation style guide](https://developers.google.com/style/)
Expand Down
4 changes: 2 additions & 2 deletions spiceaidocs/docs/acknowledgements/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: Open Source Acknowledgements
sidebar_label: Acknowledgements
sidebar_position: 100
description: 'Spice.ai acknowledges the following open source projects for making this project possible:'
description: 'Spice AI acknowledges the following open source projects for making this project possible:'
---

Spice.ai acknowledges the following open source projects for making this project possible:
Spice AI acknowledges the following open source projects for making this project possible:

### Go Modules

Expand Down
14 changes: 7 additions & 7 deletions spiceaidocs/docs/cli/index.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
---
title: 'Spice.ai CLI documentation'
title: 'Spice.ai OSS CLI documentation'
sidebar_label: 'CLI'
description: 'Detailed documentation on the Spice.ai CLI'
description: 'Detailed documentation on the Spice.ai OSS CLI'
sidebar_position: 9
---

The Spice.ai CLI is a set of commands to create and manage Spice.ai pods and interact with the Spice.ai runtime.
The Spice.ai OSS CLI is a set of commands to create and manage spicepods and interact with the Spice runtime.
phillipleblanc marked this conversation as resolved.
Show resolved Hide resolved

## Install

The Spice.ai CLI can be installed by:
The Spice CLI can be installed by:

- Running `curl https://install.spiceai.org | /bin/bash`
- Downloading the binary from [GitHub Releases](https://github.com/spiceai/spiceai/releases)

The `spice` program will be added to the PATH automatically for **bash**, **fish**, and **zsh** shells.

After installing the Spice.ai CLI for the first time, ensuring you've got the correct version by running `spice version`. The Runtime version is not expected to be shown, as the runtime will be downloaded and installed automatically upon first run.
After installing the Spice CLI for the first time, ensure you've got the correct version by running `spice version`. The Runtime version is not expected to be shown, as the runtime will be downloaded and installed automatically upon first run.

## Getting started

For getting started with Spice.ai using the Spice.ai CLI, see the [Getting Started Guide](/getting-started).
For getting started with Spice using the Spice CLI, see the [Getting Started Guide](/getting-started).

Use `spice help` for all commands and `spice [command] --help` for more information about a command.

Expand Down Expand Up @@ -68,6 +68,6 @@ Upgrade command is supported from CLI v0.3.1. For version < 0.3.1 users have to

## Uninstall

The Spice.ai CLI is installed by default to `$HOME/.spice/bin/spice` and a line added to the shell config, such as `.zshrc`
The Spice CLI is installed by default to `$HOME/.spice/bin/spice` and a line added to the shell config, such as `.zshrc`

It can be uninstalled by deleting the `spice` binary and removing the PATH addition from the rc file.
12 changes: 6 additions & 6 deletions spiceaidocs/docs/cli/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Spice.ai CLI command reference"
sidebar_label: "Spice.ai CLI command reference"
description: "Spice.ai CLI command reference"
title: "Spice.ai OSS CLI command reference"
sidebar_label: "Spice CLI command reference"
description: "Spice CLI command reference"
---

# spice
Expand All @@ -22,11 +22,11 @@ spice [command] [--help]
| [datasets](/cli/reference/datasets) | Lists datasets loaded by the Spice runtime |
| help | Help about any command |
| [init](/cli/reference/init) | Initialize Pod - initializes a new pod in the project |
| [login](/cli/reference/login) | Login to Spice.ai |
| [login](/cli/reference/login) | Login to the Spice.ai Platform |
| [models](/cli/reference/models) | Lists models loaded by the Spice runtime |
| [pods](/cli/reference/pods) | Lists Spicepods loaded by the Spice runtime |
| [run](/cli/reference/run) | Run Spice.ai - starts the Spice.ai runtime, installing if necessary |
| [sql](/cli/reference/sql) | Start an interactive SQL query session against the Spice.ai runtime |
| [run](/cli/reference/run) | Run Spice - starts the Spice runtime, installing if necessary |
| [sql](/cli/reference/sql) | Start an interactive SQL query session against the Spice runtime |
| [status](/cli/reference/status) | Spice runtime status |
| [upgrade](/cli/reference/upgrade) | Upgrades the Spice CLI to the latest release |
| [version](/cli/reference/version) | Spice CLI version |
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/cli/reference/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "login"
sidebar_label: "login"
---

Login to Spice.ai
Login to the Spice.ai Platform, or other services with sub-commands.

### Usage:
```shell
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/cli/reference/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "run"
sidebar_label: "run"
---
Run Spice.ai - starts the Spice.ai runtime, installing if necessary
Run Spice - starts the Spice runtime, installing if necessary

### Usage:
```shell
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/cli/reference/sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "sql"
sidebar_label: "sql"
---

Start an interactive SQL query session against the Spice.ai runtime
Start an interactive SQL query session against the Spice runtime

### Usage:
```shell
Expand Down
10 changes: 5 additions & 5 deletions spiceaidocs/docs/clients/DBeaver/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: "DBeaver"
sidebar_label: "DBeaver"
description: 'Configure DBeaver to query Spice.ai via JDBC'
description: 'Configure DBeaver to query Spice via JDBC'
sidebar_position: 2
---

1. Start the Spice.ai runtime with a dataset loaded. Follow the [quickstart guide](/getting-started) to get started.
1. Start the Spice runtime with a dataset loaded. Follow the [quickstart guide](/getting-started) to get started.

2. Download [DBeaver Community Edition](https://dbeaver.io).

Expand Down Expand Up @@ -45,13 +45,13 @@ sidebar_position: 2
1. Choose the ```Apache Arrow Flight SQL``` driver - the window should look like this:
![Connect to a database window](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/61cee5fe-dc75-4ac1-e558-eea3aff4c100/public "Connect to a database window")
1. Click the blue "Next >" button on the bottom of the window
1. On the next screen, the JDBC URL should be filled out already - just supply the Host (`localhost`) and Port (`50051`) values for the Spice.ai runtime. The window should look like this:
1. On the next screen, the JDBC URL should be filled out already - just supply the Host (`localhost`) and Port (`50051`) values for the Spice runtime. The window should look like this:
![Connect to a database window 2](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/2a2b2fdc-00db-49d3-5359-059b12342b00/public "Connect to a database window 2")
1. Click the "Test Connection" button - the window should look like this:
![Test Connection results](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/a3fc5f5f-a39f-47ce-7955-4b384ec1ae00/public "Test Connection results")
1. Click the blue "OK" button to close the Connection test window
1. Click the "Connection details (name, type, ...)" button on the right
1. In the "General" section, enter: `Spice.ai Runtime` for the "Connection name". It should look like this:
1. In the "General" section, enter: `Spice Runtime` for the "Connection name". It should look like this:
![Name the Database Connection](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/f6d04fe1-92a1-4082-d4ea-e9daacaca200/public)
1. Click the blue "Finish" button to save the connection

Expand All @@ -63,4 +63,4 @@ sidebar_position: 2
![Execute SQL](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/2134e47b-a066-47e9-1d48-06352675f400/public "Execute SQL")
1. See the query results as shown in this screenshot:
![Query Results](https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/0e9f3c0f-2e03-47f9-8d5e-65e078d7e900/public "Query Results")
1. DBeaver is now configured to query the Spice.ai runtime using SQL! 🎉
1. DBeaver is now configured to query the Spice runtime using SQL! 🎉
4 changes: 2 additions & 2 deletions spiceaidocs/docs/clients/arrow-flight-sql/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
title: "Arrow Flight SQL"
sidebar_label: "Arrow Flight SQL"
sidebar_position: 1
description: "Query Spice.ai using JDBC/ODBC/ADBC"
description: "Query Spice using JDBC/ODBC/ADBC"
---

Arrow Flight SQL is a protocol for interacting with SQL databases using the Arrow in-memory format and the Flight RPC framework. Spice.ai implements the Flight SQL protocol which enables querying the datasets configured in Spice.ai via tools that support connecting via one of the Arrow Flight SQL drivers, such as [DBeaver](https://dbeaver.io), [Tableau](https://www.tableau.com/), or [Power BI](https://www.microsoft.com/en-us/power-platform/products/power-bi).
Arrow Flight SQL is a protocol for interacting with SQL databases using the Arrow in-memory format and the Flight RPC framework. Spice implements the Flight SQL protocol which enables querying the datasets configured in Spice via tools that support connecting via one of the Arrow Flight SQL drivers, such as [DBeaver](https://dbeaver.io), [Tableau](https://www.tableau.com/), or [Power BI](https://www.microsoft.com/en-us/power-platform/products/power-bi).

<img src="https://imagedelivery.net/HyTs22ttunfIlvyd6vumhQ/0a8bc474-03c3-4c1c-8003-d250cd52b300/public" />

22 changes: 11 additions & 11 deletions spiceaidocs/docs/clients/superset/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,44 @@
title: 'Apache Superset'
sidebar_label: 'Apache Superset'
sidebar_position: 10
description: 'Use Apache Superset to query and visualize datasets loaded in Spice.ai.'
description: 'Use Apache Superset to query and visualize datasets loaded in Spice.'
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

Use [Apache Superset](https://superset.apache.org/) to query and visualize datasets loaded in Spice.ai.
Use [Apache Superset](https://superset.apache.org/) to query and visualize datasets loaded in Spice.

> Apache Superset is a modern, enterprise-ready business intelligence web application. It is fast, lightweight, intuitive, and loaded with options that make it easy for users of all skill sets to explore and visualize their data, from simple pie charts to highly detailed deck.gl geospatial charts.
>
> – [Apache Superset documentation](https://superset.apache.org/docs/intro/)

## Start Apache Superset with Flight SQL & DataFusion SQL Dialect support

Superset requires a Python [DB API 2](https://peps.python.org/pep-0249/) database driver and a [SQLAlchemy](https://www.sqlalchemy.org/) dialect to be installed for each connected datastore. Spice.ai implements a Flight SQL server that understands the DataFusion SQL Dialect. The [`flightsql-dbapi`](https://pypi.org/project/flightsql-dbapi/) library for Python provides the required DB API 2 driver and SQLAlchemy dialect.
Superset requires a Python [DB API 2](https://peps.python.org/pep-0249/) database driver and a [SQLAlchemy](https://www.sqlalchemy.org/) dialect to be installed for each connected datastore. Spice implements a Flight SQL server that understands the DataFusion SQL Dialect. The [`flightsql-dbapi`](https://pypi.org/project/flightsql-dbapi/) library for Python provides the required DB API 2 driver and SQLAlchemy dialect.

Select the appropriate tab based on whether you are experimenting with this feature or integrating it into an existing Superset instance.

<Tabs>
<TabItem value="experimenting" label="Experimenting" default>
The easiest way to connect Apache Superset and Spice.ai is to follow the [`Sales BI` sample](https://github.com/spiceai/samples/tree/trunk/sales-bi). This sample builds a local Docker image based on Apache Superset that is pre-configured with the `flightsql-dbapi` library needed to connect to Spice.ai.
The easiest way to connect Apache Superset and Spice is to follow the [`Sales BI` sample](https://github.com/spiceai/samples/tree/trunk/sales-bi). This sample builds a local Docker image based on Apache Superset that is pre-configured with the `flightsql-dbapi` library needed to connect to Spice.

Clone the Spice.ai samples repository and navigate to the `sales-bi` directory:
Clone the Spice samples repository and navigate to the `sales-bi` directory:

```bash
git clone https://github.com/spiceai/samples.git
cd samples/sales-bi
```

Start Apache Superset along with the Spice.ai runtime in Docker Compose:
Start Apache Superset along with the Spice runtime in Docker Compose:

```bash
make start
```

Log into Apache Superset at [http://localhost:8088](http://localhost:8088) with the username and password `admin/admin`.

Follow the below steps to configure a database connection to Spice.ai manually, or run `make import-dashboards` to automatically configure the connection and create a sample dashboard.
Follow the below steps to configure a database connection to Spice manually, or run `make import-dashboards` to automatically configure the connection and create a sample dashboard.
</TabItem>
<TabItem value="existing" label="Integrating with Existing Superset">
## Generic / Virtual Machine
Expand Down Expand Up @@ -78,9 +78,9 @@ Select the appropriate tab based on whether you are experimenting with this feat

---

## Configure a Spice.ai Connection
## Configure a Spice Connection

Once Apache Superset is up and running, and you are logged in, you can configure a connection to Spice.ai.
Once Apache Superset is up and running, and you are logged in, you can configure a connection to Spice.

Hover over the `Settings` menu and select `Database Connections`.

Expand All @@ -92,7 +92,7 @@ Click the `+ Database` button to configure the connection.

Under `Supported Databases` select `Other`.

Set the Display Name to `Spice.ai` and the SQL Alchemy URI to `datafusion+flightsql://spiceai_host:[spiceai_port]`. Specify `?insecure=true` to skip connecting over TLS.
Set the Display Name to `Spice` and the SQL Alchemy URI to `datafusion+flightsql://spiceai_host:[spiceai_port]`. Specify `?insecure=true` to skip connecting over TLS.

Example: `datafusion+flightsql://spiceai-sales-bi-demo:50051?insecure=true`.

Expand All @@ -102,4 +102,4 @@ Click `Test Connection` to verify the connection.

Click `Connect` to save the connection.

Start exploring the datasets loaded in Spice.ai by creating a new dataset in Apache Superset to match one of the existing tables.
Start exploring the datasets loaded in Spice by creating a new dataset in Apache Superset to match one of the existing tables.
6 changes: 3 additions & 3 deletions spiceaidocs/docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: 'Getting started with Spice.ai'
title: 'Getting started with Spice.ai OSS'
sidebar_label: 'Getting started'
sidebar_position: 1
description: 'Get started with Spice.ai in 5 minutes'
description: 'Get started with Spice in 5 minutes'
---

### Follow these steps to get started with Spice.ai.
### Follow these steps to get started with Spice.

**Step 1.** Install the Spice CLI:

Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Spice is under active **alpha** stage development and is not intended to be used
We greatly appreciate and value your support! You can help Spice in a number of ways:

- ⭐️ Star this repo.
- Build an app with Spice.ai and send us feedback and suggestions at [[email protected]](mailto:[email protected]) or on [Discord](https://discord.gg/kZnTfneP5u), [X](https://twitter.com/spice_ai), or [LinkedIn](https://www.linkedin.com/company/74148478).
- Build an app with Spice and send us feedback and suggestions at [[email protected]](mailto:[email protected]) or on [Discord](https://discord.gg/kZnTfneP5u), [X](https://twitter.com/spice_ai), or [LinkedIn](https://www.linkedin.com/company/74148478).
- [File an issue](https://github.com/spiceai/spiceai/issues/new) if you see something not quite working correctly.
- Join our team ([We’re hiring!](https://spice.ai/careers))
- Contribute code or documentation to the project (see [CONTRIBUTING.md](https://github.com/spiceai/spiceai/blob/trunk/CONTRIBUTING.md)).
Expand Down
4 changes: 2 additions & 2 deletions spiceaidocs/docs/reference/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: 'Spice.ai Reference Docs'
title: 'Spice.ai OSS Reference Docs'
sidebar_label: 'Reference'
sidebar_position: 11
description: 'Reference documentation on the Spice.ai API, CLI and Pod manifest syntax.'
description: 'Reference documentation on the Spice API, CLI and Pod manifest syntax.'
---
17 changes: 4 additions & 13 deletions spiceaidocs/docs/reference/spicepod/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,27 +67,18 @@ A datasets referenced by relative path.

```yaml
datasets:
- from: datasets/uniswap_v2_eth_usdc
```

A datasets with a dependency on another dataset.

```yaml
datasets:
- from: datasets/uniswap_v2_eth_usdc
dependsOn: datasets/uniswap_eth_usdc
- ref: datasets/uniswap_v2_eth_usdc
```

A dataset defined inline.

```yaml
datasets:
- name: spiceai.uniswap_v2_eth_usdc
type: overwrite
source: spice.ai
- name: spice.ai/eth.recent_blocks
acceleration:
enabled: true
refresh: 1h
refresh_mode: full
refresh_interval: 1h
```

## `models`
Expand Down
2 changes: 1 addition & 1 deletion spiceaidocs/docs/reference/timestamp.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: "Timestamps"
sidebar_label: "Timestamps"
---

In Spice.ai all timestamps are represented as an integer value denoting the number of seconds that have passed since the _Unix epoch_ in UTC time. The Unix epoch is defined as 1970-01-01T00:00:00Z.
In Spice all timestamps are represented as an integer value denoting the number of seconds that have passed since the _Unix epoch_ in UTC time. The Unix epoch is defined as 1970-01-01T00:00:00Z.

More information about Unix time can be found on [Wikipedia](https://en.wikipedia.org/wiki/Unix_time).

Expand Down
8 changes: 4 additions & 4 deletions spiceaidocs/docusaurus.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type { Config } from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

const config: Config = {
title: 'Spice.ai Docs',
title: 'Spice.ai OSS Docs',
tagline:
'A unified SQL query interface and portable runtime to locally materialize, accelerate, and query data tables sourced from any database, data warehouse, or data lake.',
favicon: 'img/favicon.ico',
Expand Down Expand Up @@ -53,15 +53,15 @@ const config: Config = {
// image: 'img/docusaurus-social-card.jpg',
announcementBar: {
content:
'We\'ve just released <a href="https://github.com/spiceai/spiceai/releases">Spice.ai v0.9.1-alpha</a>! 🚀',
'We\'ve just released <a href="https://github.com/spiceai/spiceai/releases">Spice v0.9.1-alpha</a>! 🚀',
backgroundColor: '#fafbfc',
textColor: '#091E42',
isCloseable: true,
},
navbar: {
title: 'Spice.ai Docs',
title: 'Spice.ai OSS Docs',
logo: {
alt: 'Spice.ai logo',
alt: 'Spice.ai OSS logo',
src: 'img/logo.svg',
},
hideOnScroll: true,
Expand Down