diff --git a/README.md b/README.md index 5f22e1ebd..0ccbb5676 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,8 @@ SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg SPDX-License-Identifier: AGPL-3.0-only --> +![Jayvee Mascot](./assets/mascot1.png) + # Jayvee Jayvee is a domain-specific language (DSL) for automated processing of data pipelines. diff --git a/apps/docs/docs/dev/01-intro.md b/apps/docs/docs/dev/01-intro.mdx similarity index 91% rename from apps/docs/docs/dev/01-intro.md rename to apps/docs/docs/dev/01-intro.mdx index fef3c08e1..cdb9efe14 100644 --- a/apps/docs/docs/dev/01-intro.md +++ b/apps/docs/docs/dev/01-intro.mdx @@ -4,6 +4,18 @@ sidebar_position: 1 # Introduction for Jayvee Developers +import MascotImageUrl from '@site/static/img/mascots/mascot3.png'; + +
+
+ +
+ + +

"On the tracks of Jayvee's internals"

+
+
+ ## How to contribute In order to contribute to the Jayvee project, please have a look at our [contribution guide](https://github.com/jvalue/jayvee/blob/main/CONTRIBUTING.md). Before planning a contribution, please read the [design principles](./05-design-principles.md) and consider if your changes fit the vision expressed there. diff --git a/apps/docs/docs/dev/01-intro.md.license b/apps/docs/docs/dev/01-intro.mdx.license similarity index 100% rename from apps/docs/docs/dev/01-intro.md.license rename to apps/docs/docs/dev/01-intro.mdx.license diff --git a/apps/docs/docs/user/intro/intro.md b/apps/docs/docs/user/intro/intro.mdx similarity index 88% rename from apps/docs/docs/user/intro/intro.md rename to apps/docs/docs/user/intro/intro.mdx index c2b4bc054..7cd5a4010 100644 --- a/apps/docs/docs/user/intro/intro.md +++ b/apps/docs/docs/user/intro/intro.mdx @@ -5,6 +5,18 @@ title: Getting Started # Introduction to Jayvee +import MascotImageUrl from '@site/static/img/mascots/mascot2.png'; + +
+
+ +
+ + +

"Making data engineering easy, reliable, and safe"

+
+
+ 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. diff --git a/apps/docs/docs/user/intro/intro.md.license b/apps/docs/docs/user/intro/intro.mdx.license similarity index 100% rename from apps/docs/docs/user/intro/intro.md.license rename to apps/docs/docs/user/intro/intro.mdx.license diff --git a/apps/docs/src/pages/index.tsx b/apps/docs/src/pages/index.tsx index d3e74c9e7..023b40d77 100644 --- a/apps/docs/src/pages/index.tsx +++ b/apps/docs/src/pages/index.tsx @@ -9,42 +9,43 @@ import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; import HomepageFeatures from '@site/src/components/HomepageFeatures'; +import MascotImageUrl from '@site/static/img/mascots/mascot1.png'; + import styles from './index.module.css'; function HomepageHeader() { return (
- +
); } - function TitleBanner(): JSX.Element { return (
- 🥳 - Jayvee's alpha is now available! + 🥳 + + Jayvee's Alpha is now available! + 🎉
- A domain-specific language for everyone to participate in building data pipelines! + A domain-specific language for everyone to participate{' '} + in building data pipelines!
- + + + + Get Started - + Example @@ -59,7 +60,7 @@ function TitleBanner(): JSX.Element {
- ) + ); } export default function Home(): JSX.Element { diff --git a/apps/docs/static/img/mascots/mascot1.png b/apps/docs/static/img/mascots/mascot1.png new file mode 100644 index 000000000..6d1d780d6 Binary files /dev/null and b/apps/docs/static/img/mascots/mascot1.png differ diff --git a/apps/docs/static/img/mascots/mascot1.png.license b/apps/docs/static/img/mascots/mascot1.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/apps/docs/static/img/mascots/mascot1.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/apps/docs/static/img/mascots/mascot2.png b/apps/docs/static/img/mascots/mascot2.png new file mode 100644 index 000000000..b7b9adf17 Binary files /dev/null and b/apps/docs/static/img/mascots/mascot2.png differ diff --git a/apps/docs/static/img/mascots/mascot2.png.license b/apps/docs/static/img/mascots/mascot2.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/apps/docs/static/img/mascots/mascot2.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/apps/docs/static/img/mascots/mascot3.png b/apps/docs/static/img/mascots/mascot3.png new file mode 100644 index 000000000..9c0d10406 Binary files /dev/null and b/apps/docs/static/img/mascots/mascot3.png differ diff --git a/apps/docs/static/img/mascots/mascot3.png.license b/apps/docs/static/img/mascots/mascot3.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/apps/docs/static/img/mascots/mascot3.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/assets/docs-banner.png.license b/assets/docs-banner.png.license index 17c5d2bad..ee78e3537 100644 --- a/assets/docs-banner.png.license +++ b/assets/docs-banner.png.license @@ -1,3 +1,7 @@ SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/assets/mascot1.original.png b/assets/mascot1.original.png new file mode 100644 index 000000000..6ffa8d1bc Binary files /dev/null and b/assets/mascot1.original.png differ diff --git a/assets/mascot1.original.png.license b/assets/mascot1.original.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/assets/mascot1.original.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/assets/mascot1.png b/assets/mascot1.png new file mode 100644 index 000000000..6d1d780d6 Binary files /dev/null and b/assets/mascot1.png differ diff --git a/assets/mascot1.png.license b/assets/mascot1.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/assets/mascot1.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/assets/mascot2.original.png b/assets/mascot2.original.png new file mode 100644 index 000000000..18cff4949 Binary files /dev/null and b/assets/mascot2.original.png differ diff --git a/assets/mascot2.original.png.license b/assets/mascot2.original.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/assets/mascot2.original.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/assets/mascot2.png b/assets/mascot2.png new file mode 100644 index 000000000..b7b9adf17 Binary files /dev/null and b/assets/mascot2.png differ diff --git a/assets/mascot2.png.license b/assets/mascot2.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/assets/mascot2.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/assets/mascot3.original.png b/assets/mascot3.original.png new file mode 100644 index 000000000..04aceb20f Binary files /dev/null and b/assets/mascot3.original.png differ diff --git a/assets/mascot3.original.png.license b/assets/mascot3.original.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/assets/mascot3.original.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06 diff --git a/assets/mascot3.png b/assets/mascot3.png new file mode 100644 index 000000000..9c0d10406 Binary files /dev/null and b/assets/mascot3.png differ diff --git a/assets/mascot3.png.license b/assets/mascot3.png.license new file mode 100644 index 000000000..ee78e3537 --- /dev/null +++ b/assets/mascot3.png.license @@ -0,0 +1,7 @@ +SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + +SPDX-License-Identifier: AGPL-3.0-only + +Info: This image is based on a generated image by Midjourney (Basic subscription). +Midjourney ToS: https://docs.midjourney.com/docs/terms-of-service or archived on https://web.archive.org/web/20240205060308/https://docs.midjourney.com/docs/terms-of-service. +Date of creation: 2024-02-06