From 7db0a007490936d12af42c068669b6a0b8cbe3a9 Mon Sep 17 00:00:00 2001 From: Phillip LeBlanc Date: Wed, 27 Mar 2024 11:53:02 +0900 Subject: [PATCH 1/2] Update naming to be consistent --- CONTRIBUTING.md | 6 ++--- spiceaidocs/docs/acknowledgements/index.md | 4 ++-- spiceaidocs/docs/cli/index.md | 14 ++++++------ spiceaidocs/docs/cli/reference/index.md | 12 +++++----- spiceaidocs/docs/cli/reference/login.md | 2 +- spiceaidocs/docs/cli/reference/run.md | 2 +- spiceaidocs/docs/cli/reference/sql.md | 2 +- spiceaidocs/docs/clients/DBeaver/index.md | 10 ++++----- .../docs/clients/arrow-flight-sql/index.md | 4 ++-- spiceaidocs/docs/clients/superset/index.md | 22 +++++++++---------- spiceaidocs/docs/getting-started/index.md | 6 ++--- spiceaidocs/docs/index.md | 2 +- spiceaidocs/docs/reference/index.md | 4 ++-- spiceaidocs/docs/reference/spicepod/index.md | 17 ++++---------- spiceaidocs/docs/reference/timestamp.md | 2 +- spiceaidocs/docusaurus.config.ts | 8 +++---- 16 files changed, 54 insertions(+), 63 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index fd8bd29c4..acdfdaac9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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/) diff --git a/spiceaidocs/docs/acknowledgements/index.md b/spiceaidocs/docs/acknowledgements/index.md index 4de77f020..6fbb40322 100644 --- a/spiceaidocs/docs/acknowledgements/index.md +++ b/spiceaidocs/docs/acknowledgements/index.md @@ -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 diff --git a/spiceaidocs/docs/cli/index.md b/spiceaidocs/docs/cli/index.md index 41159ff80..aa0c754dd 100644 --- a/spiceaidocs/docs/cli/index.md +++ b/spiceaidocs/docs/cli/index.md @@ -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. ## 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. @@ -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. diff --git a/spiceaidocs/docs/cli/reference/index.md b/spiceaidocs/docs/cli/reference/index.md index 1b6dbeab5..3eddd75de 100644 --- a/spiceaidocs/docs/cli/reference/index.md +++ b/spiceaidocs/docs/cli/reference/index.md @@ -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 @@ -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 | diff --git a/spiceaidocs/docs/cli/reference/login.md b/spiceaidocs/docs/cli/reference/login.md index 2f7565a2c..c261215e4 100644 --- a/spiceaidocs/docs/cli/reference/login.md +++ b/spiceaidocs/docs/cli/reference/login.md @@ -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 diff --git a/spiceaidocs/docs/cli/reference/run.md b/spiceaidocs/docs/cli/reference/run.md index 9714aa3c7..fc06cc9c8 100644 --- a/spiceaidocs/docs/cli/reference/run.md +++ b/spiceaidocs/docs/cli/reference/run.md @@ -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 diff --git a/spiceaidocs/docs/cli/reference/sql.md b/spiceaidocs/docs/cli/reference/sql.md index 7e9bdd23a..1125ddbf5 100644 --- a/spiceaidocs/docs/cli/reference/sql.md +++ b/spiceaidocs/docs/cli/reference/sql.md @@ -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 diff --git a/spiceaidocs/docs/clients/DBeaver/index.md b/spiceaidocs/docs/clients/DBeaver/index.md index 841a2afce..246fa7f4c 100644 --- a/spiceaidocs/docs/clients/DBeaver/index.md +++ b/spiceaidocs/docs/clients/DBeaver/index.md @@ -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). @@ -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 @@ -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! πŸŽ‰ \ No newline at end of file + 1. DBeaver is now configured to query the Spice runtime using SQL! πŸŽ‰ \ No newline at end of file diff --git a/spiceaidocs/docs/clients/arrow-flight-sql/index.md b/spiceaidocs/docs/clients/arrow-flight-sql/index.md index a5b7ad6ee..046fd0d2a 100644 --- a/spiceaidocs/docs/clients/arrow-flight-sql/index.md +++ b/spiceaidocs/docs/clients/arrow-flight-sql/index.md @@ -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). diff --git a/spiceaidocs/docs/clients/superset/index.md b/spiceaidocs/docs/clients/superset/index.md index 2be5f2376..febd7f9c9 100644 --- a/spiceaidocs/docs/clients/superset/index.md +++ b/spiceaidocs/docs/clients/superset/index.md @@ -2,13 +2,13 @@ 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. > @@ -16,22 +16,22 @@ Use [Apache Superset](https://superset.apache.org/) to query and visualize datas ## 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. - 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 @@ -39,7 +39,7 @@ Select the appropriate tab based on whether you are experimenting with this feat 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. ## Generic / Virtual Machine @@ -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`. @@ -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`. @@ -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. \ No newline at end of file +Start exploring the datasets loaded in Spice by creating a new dataset in Apache Superset to match one of the existing tables. \ No newline at end of file diff --git a/spiceaidocs/docs/getting-started/index.md b/spiceaidocs/docs/getting-started/index.md index 92375a5be..e79959eb7 100644 --- a/spiceaidocs/docs/getting-started/index.md +++ b/spiceaidocs/docs/getting-started/index.md @@ -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: diff --git a/spiceaidocs/docs/index.md b/spiceaidocs/docs/index.md index 0af34119c..d2f5b9bec 100644 --- a/spiceaidocs/docs/index.md +++ b/spiceaidocs/docs/index.md @@ -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 [hey@spice.ai](mailto:hey@spice.ai) 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 [hey@spice.ai](mailto:hey@spice.ai) 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)). diff --git a/spiceaidocs/docs/reference/index.md b/spiceaidocs/docs/reference/index.md index 341b1e840..cf64e2158 100644 --- a/spiceaidocs/docs/reference/index.md +++ b/spiceaidocs/docs/reference/index.md @@ -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.' --- diff --git a/spiceaidocs/docs/reference/spicepod/index.md b/spiceaidocs/docs/reference/spicepod/index.md index b29558525..38bac835c 100644 --- a/spiceaidocs/docs/reference/spicepod/index.md +++ b/spiceaidocs/docs/reference/spicepod/index.md @@ -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` diff --git a/spiceaidocs/docs/reference/timestamp.md b/spiceaidocs/docs/reference/timestamp.md index c70632c1d..c7c63ea5a 100644 --- a/spiceaidocs/docs/reference/timestamp.md +++ b/spiceaidocs/docs/reference/timestamp.md @@ -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). diff --git a/spiceaidocs/docusaurus.config.ts b/spiceaidocs/docusaurus.config.ts index ed12a1878..e8c31eb5e 100644 --- a/spiceaidocs/docusaurus.config.ts +++ b/spiceaidocs/docusaurus.config.ts @@ -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', @@ -53,15 +53,15 @@ const config: Config = { // image: 'img/docusaurus-social-card.jpg', announcementBar: { content: - 'We\'ve just released Spice.ai v0.9.1-alpha! πŸš€', + 'We\'ve just released Spice v0.9.1-alpha! πŸš€', 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, From b06113eebbcfcfad6d432fde7f8e6e3667cbf21d Mon Sep 17 00:00:00 2001 From: Phillip LeBlanc Date: Wed, 27 Mar 2024 12:01:29 +0900 Subject: [PATCH 2/2] review feedback --- spiceaidocs/docs/cli/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spiceaidocs/docs/cli/index.md b/spiceaidocs/docs/cli/index.md index aa0c754dd..c7d7e59c5 100644 --- a/spiceaidocs/docs/cli/index.md +++ b/spiceaidocs/docs/cli/index.md @@ -5,7 +5,7 @@ description: 'Detailed documentation on the Spice.ai OSS CLI' sidebar_position: 9 --- -The Spice.ai OSS CLI is a set of commands to create and manage spicepods and interact with the Spice runtime. +The Spice CLI is a set of commands to create and manage Spicepods and interact with the Spice runtime. ## Install