From 36882bd1a2b2a53289369220d4465de5dba9e008 Mon Sep 17 00:00:00 2001 From: Georg Schwarz Date: Fri, 15 Dec 2023 09:58:36 +0100 Subject: [PATCH] Update Jayvee description in README and docs --- README.md | 29 ++++++++++++++--------------- apps/docs/docs/user/intro.md | 22 +++++++++++++--------- 2 files changed, 27 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 8b694fdb4..e8584e9ea 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,9 @@ SPDX-License-Identifier: AGPL-3.0-only # Jayvee -Jayvee is a DSL to model and execute automated data pipelines, e.g., for data engineering. +Jayvee is a domain-specific language (DSL) for automated processing of data pipelines. +The Jayvee interpreter allows executing such data pipelines on local machines. +Data engineers can use Jayvee and its interpreter to clean and preprocess data for later activities like data science or machine learning. [![Official Docs](assets/docs-banner.png)](https://jvalue.github.io/jayvee) @@ -26,23 +28,20 @@ In case you would like to contribute to Jayvee, please have a look at our [contr In case you run into problems, make sure to use the current LTS version of Node.js and npm. - ## Projects overview -| Name | Description | NPM package | -|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------| ------------------------------------------ | -| [`language-server`](./libs/language-server) | Jayvee language definition and language server implementation | [@jvalue/jayvee-language-server](https://www.npmjs.com/package/@jvalue/jayvee-language-server) | -| [`interpreter`](./apps/interpreter) | Command line tool for interpreting Jayvee files | [@jvalue/jayvee-interpreter](https://www.npmjs.com/package/@jvalue/jayvee-interpreter) | +| Name | Description | NPM package | +| ----------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | +| [`language-server`](./libs/language-server) | Jayvee language definition and language server implementation | [@jvalue/jayvee-language-server](https://www.npmjs.com/package/@jvalue/jayvee-language-server) | +| [`interpreter`](./apps/interpreter) | Command line tool for interpreting Jayvee files | [@jvalue/jayvee-interpreter](https://www.npmjs.com/package/@jvalue/jayvee-interpreter) | | [`language-server-web-worker`](./apps/language-server-web-worker) | Ready-to-use Jayvee language server, bundled as a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API) | [@jvalue/jayvee-language-server-web-worker](https://www.npmjs.com/package/@jvalue/jayvee-language-server-web-worker) | -| [`vs-code-extension`](./apps/vs-code-extension) | Visual Studio Code extension for editing Jayvee files | - | -| [`docs`](./apps/docs) | Website for Jayvee user documentation | - | -| [`monaco-editor`](./libs/monaco-editor) | React component for editing Jayvee files | [@jvalue/jayvee-monaco](https://www.npmjs.com/package/@jvalue/jayvee-monaco) | -| [`execution`](./libs/execution) | Shared code for Jayvee extensions and the interpreter | - | -| [`extensions/std`](./libs/extensions/std) | Standard Jayvee extension consisting of the extensions below | - | -| [`extensions/rdbms`](./libs/extensions/rdbms) | Jayvee extension for relational databases | - | -| [`extensions/tabular`](./libs/extensions/tabular) | Jayvee extension for tabular data | - | - - +| [`vs-code-extension`](./apps/vs-code-extension) | Visual Studio Code extension for editing Jayvee files | - | +| [`docs`](./apps/docs) | Website for Jayvee user documentation | - | +| [`monaco-editor`](./libs/monaco-editor) | React component for editing Jayvee files | [@jvalue/jayvee-monaco](https://www.npmjs.com/package/@jvalue/jayvee-monaco) | +| [`execution`](./libs/execution) | Shared code for Jayvee extensions and the interpreter | - | +| [`extensions/std`](./libs/extensions/std) | Standard Jayvee extension consisting of the extensions below | - | +| [`extensions/rdbms`](./libs/extensions/rdbms) | Jayvee extension for relational databases | - | +| [`extensions/tabular`](./libs/extensions/tabular) | Jayvee extension for tabular data | - | ## Scripts diff --git a/apps/docs/docs/user/intro.md b/apps/docs/docs/user/intro.md index 2832707c1..33e4bb6ad 100644 --- a/apps/docs/docs/user/intro.md +++ b/apps/docs/docs/user/intro.md @@ -4,7 +4,9 @@ sidebar_position: 1 # Introduction to Jayvee -Jayvee is a domain-specific language (DSL) for data engineering - the cleaning and preprocessing of data for later activities like data science or machine learning. You can use Jayvee to **model an ETL pipeline** and the command-line interpreter to **run the ETL pipeline** on your local machine. +Jayvee is a domain-specific language (DSL) for automated processing of data pipelines. +The Jayvee interpreter allows executing such data pipelines on local machines. +Data engineers can use Jayvee and its interpreter to clean and preprocess data for later activities like data science or machine learning. ## Installation @@ -15,6 +17,7 @@ npm install -g @jvalue/jayvee-interpreter ``` You can install a specific version using the `@`-syntax, e.g., version `0.0.17`: + ```bash npm install -g @jvalue/jayvee-interpreter@0.0.17 ``` @@ -47,7 +50,6 @@ Run with **additional debug output**: jv -d ``` - With **runtime parameters**: ```console @@ -61,35 +63,37 @@ Print debugging is further configured by the parameters `--debug-granularity` an ```console jv -d -dg peek ``` + The value of the parameter `--debug-granularity` (short `-dg`) can have the following values: -- `peek` to log a short summary, including a small subset of data + +- `peek` to log a short summary, including a small subset of data - `exhaustive` to log a summary, including the full data - `minimal` to log a summary, including no additional data (default). -To see logs, debugging has to be enabled using the `-d` flag. + To see logs, debugging has to be enabled using the `-d` flag. ```console jv -d --debug-granularity peek ``` + The parameter `--debug-target` (short `-dt`) allows to specify which blocks should be logged for debugging. Separate block names by comma if multiple blocks are targeted. All blocks are logged if the parameter is omitted. + ```console jv -d --debug-granularity peek --debug-target MyExtractorBlock,MySinkBlock ``` - ## Examples You can find multiple examples [here](https://github.com/jvalue/jayvee/tree/main/example). Copy them to your local file system and execute them with the `jv` command on your command line (see [usage](#usage)). - ## VSCode Plugin To set up Jayvee locally in VS Code, you need to install the latest Jayvee VS Code extension. -To install the most recent extension, go to our [latest release](https://github.com/jvalue/jayvee/releases/latest) +To install the most recent extension, go to our [latest release](https://github.com/jvalue/jayvee/releases/latest) and download the `jayvee.vsix` file from the release assets. -Next, go to [this page](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) and +Next, go to [this page](https://code.visualstudio.com/docs/editor/extension-marketplace#_install-from-a-vsix) and follow the instructions for installing the downloaded extension. ## Troubleshooting 1. Error `structuredClone is not defined` - * Please make sure you use node version 17+. + - Please make sure you use node version 17+.