diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt new file mode 100644 index 00000000..9d72f1cc --- /dev/null +++ b/LICENSES/Apache-2.0.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. \ No newline at end of file diff --git a/apps/docs/docusaurus.config.js b/apps/docs/docusaurus.config.js index e83e708a..82b409d2 100644 --- a/apps/docs/docusaurus.config.js +++ b/apps/docs/docusaurus.config.js @@ -11,12 +11,11 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula'); /** @type {import('@docusaurus/types').Config} */ const config = { title: 'Jayvee', - tagline: 'Data engineering made easy', url: 'https://jvalue.github.io', - baseUrl: '/jayvee/', + baseUrl: '/jayvee', onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', - favicon: 'img/jayvee.png', + favicon: '/img/jayvee.png', organizationName: 'jvalue', // Usually your GitHub org/user name. projectName: 'jayvee', // Usually your repo name. themes: ['@docusaurus/theme-mermaid'], @@ -43,16 +42,8 @@ const config = { /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ ({ navbar: { - logo: { - alt: 'Jayvee logo', - src: 'img/jayvee.png', - }, + title: 'Jayvee', items: [ - { - type: 'docsVersionDropdown', - position: 'left', - dropdownActiveClassDisabled: true, - }, { type: 'doc', docId: 'user/intro', @@ -65,10 +56,16 @@ const config = { position: 'left', label: 'Developer Docs', }, + { + type: 'docsVersionDropdown', + position: 'right', + dropdownActiveClassDisabled: true, + }, { href: 'https://github.com/jvalue/jayvee', - label: 'GitHub', position: 'right', + className: 'header-github-link', + 'aria-label': 'GitHub repository', }, ], }, @@ -76,18 +73,26 @@ const config = { style: 'dark', links: [ { - title: 'User Docs', + title: 'Learn', items: [ { - label: 'Introduction to Jayvee', + label: 'Installation', to: '/docs/user/intro', }, + { + label: 'Core Concepts', + to: '/docs/user/core-concepts', + }, + { + label: 'Examples', + to: '/docs/user/examples/cars', + }, + { + label: 'Start contributing', + to: '/docs/dev/intro', + }, ], }, - { - title: 'Developer Docs', - items: [], - }, { title: 'More', items: [ @@ -95,6 +100,23 @@ const config = { label: 'GitHub', href: 'https://github.com/jvalue/jayvee', }, + { + label: 'JValue', + href: 'https://jvalue.org/', + }, + ], + }, + { + title: 'Legal', + items: [ + { + label: 'Imprint', + href: 'https://jvalue.org/notices/imprint/', + }, + { + label: 'Privacy Policy', + href: 'https://jvalue.org/notices/privacy-policy/', + }, ], }, ], diff --git a/apps/docs/src/components/HomepageFeatures/index.tsx b/apps/docs/src/components/HomepageFeatures/index.tsx index afb3b678..4cdf7ac6 100644 --- a/apps/docs/src/components/HomepageFeatures/index.tsx +++ b/apps/docs/src/components/HomepageFeatures/index.tsx @@ -5,26 +5,28 @@ import React from 'react'; import clsx from 'clsx'; import styles from './styles.module.css'; +import { useBaseUrlUtils } from '@docusaurus/useBaseUrl'; -type FeatureItem = { - title: string; - Svg: React.ComponentType>; - description: JSX.Element; -}; +import { type FeatureItem, Features } from '../../data/features'; -const FeatureList: FeatureItem[] = [ - -]; +function Feature(feature: FeatureItem) { + const {withBaseUrl} = useBaseUrlUtils(); -function Feature({ title, Svg, description }: FeatureItem) { return (
- + {feature.title}
-

{title}

-

{description}

+

{feature.title}

+
{feature.description}
); @@ -34,8 +36,9 @@ export default function HomepageFeatures(): JSX.Element { return (
+

Main Features

- {FeatureList.map((props, idx) => ( + {Features.map((props, idx) => ( ))}
diff --git a/apps/docs/src/components/HomepageFeatures/styles.module.css b/apps/docs/src/components/HomepageFeatures/styles.module.css index 2dab6d10..62da5396 100644 --- a/apps/docs/src/components/HomepageFeatures/styles.module.css +++ b/apps/docs/src/components/HomepageFeatures/styles.module.css @@ -9,9 +9,4 @@ align-items: center; padding: 2rem 0; width: 100%; -} - -.featureSvg { - height: 200px; - width: 200px; -} +} \ No newline at end of file diff --git a/apps/docs/src/css/custom.css b/apps/docs/src/css/custom.css index 1b2cf266..dead4e6e 100644 --- a/apps/docs/src/css/custom.css +++ b/apps/docs/src/css/custom.css @@ -34,3 +34,20 @@ --ifm-color-primary-lightest: #4fddbf; --docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3); } + +.header-github-link:before { + background: url("data:image/svg+xml;charset=utf-8,%3Csvg viewBox='0 0 24 24' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath d='M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12'/%3E%3C/svg%3E") no-repeat; + display: flex; + height: 24px; + width: 24px; + content: ""; +} +.header-github-link:hover { + opacity: 0.6; +} + +.navbar__title { + background: linear-gradient(45deg, var(--ifm-color-primary), var(--ifm-color-primary-lightest) 80%); + background-clip: text; + -webkit-text-fill-color: transparent; +} \ No newline at end of file diff --git a/apps/docs/src/data/features.tsx b/apps/docs/src/data/features.tsx new file mode 100644 index 00000000..4ed97997 --- /dev/null +++ b/apps/docs/src/data/features.tsx @@ -0,0 +1,74 @@ +/* + * SPDX-FileCopyrightText: 2023 Friedrich-Alexander-Universitat Erlangen-Nurnberg + * + * SPDX-License-Identifier: AGPL-3.0-only + */ + +import React from "react"; + +export type FeatureItem = { + title: string; + image: { + src: string; + height: number; + width: number; + } + description: JSX.Element; +}; + +export const Features: FeatureItem[] = [ + { + title: "Focused", + description:

Jayvee is a DSL (domain-specific language) tailored for data engineering.

, + image: { + src: '/img/features/focus.svg', + width: 100, + height: 100, + }, + }, + { + title: "Text-based", + description:

Jayvee's text-based syntax allows reuse of existing collaboration infrastructure from open source software development.

, + image: { + src: '/img/features/text.svg', + width: 100, + height: 100, + }, + }, + { + title: "Open", + description:

Jayvee is open for extension (no vendor lock-in) with a fast innovation in tools.

, + image: { + src: '/img/features/open.svg', + width: 100, + height: 100, + }, + }, + { + title: "Accessible", + description:

Jayvee enables collaboration with subject matter experts that might not be professional programmers.

, + image: { + src: '/img/features/accessible.svg', + width: 100, + height: 100, + }, + }, + { + title: "Maintainable", + description:

Jayvee passes on hidden magic to make the code more self-explaining.

, + image: { + src: '/img/features/maintainable.svg', + width: 100, + height: 100, + }, + }, + { + title: "Empirical Design", + description:

The design of Jayvee is validated with scientific methods like surveys and controlled experiments instead of relying on gut feeling.

, + image: { + src: '/img/features/research.svg', + width: 100, + height: 100, + }, + } + ]; \ No newline at end of file diff --git a/apps/docs/src/pages/index.module.css b/apps/docs/src/pages/index.module.css index 1fb178fa..de3425b0 100644 --- a/apps/docs/src/pages/index.module.css +++ b/apps/docs/src/pages/index.module.css @@ -9,21 +9,66 @@ * and scoped locally. */ -.heroBanner { - padding: 4rem 0; +.titleBanner { + text-align: center; + display: flex; + flex-direction: column; + align-items: center; text-align: center; position: relative; overflow: hidden; + color: aliceblue; + background-color: #2b3137; + padding: 4rem; } @media screen and (max-width: 996px) { - .heroBanner { + .titleBanner { padding: 2rem; } } -.buttons { +.titleBannerTitle { + font-size: 64px; + font-weight: bold; + margin: 0.5rem 0; +} + +.titleBannerTitleText { + background: linear-gradient(45deg, var(--ifm-color-primary), var(--ifm-color-info) 80%); + background-clip: text; + -webkit-text-fill-color: transparent; +} + +.titleBannerTagline { + font-size: 32px; +} + +.titleBannerTagline b { + color: var(--ifm-color-primary); +} + +.titleBannerButtons { + --ifm-button-size-multiplier: 1.5; display: flex; + flex-wrap: wrap; align-items: center; justify-content: center; + margin-top: 12px; } + +.titleBannerButtons a, +.titleBannerButtons a:hover { + color: black; + margin: 12px 12px 0px 12px; +} + +.titleBannerButtonsGitHubButtonWrapper { + margin-top: 12px; + margin-left: 12px; + display: flex; +} + +.titleBannerButtonsGitHubButton { + overflow: hidden; +} \ No newline at end of file diff --git a/apps/docs/src/pages/index.tsx b/apps/docs/src/pages/index.tsx index be2c207a..fe4dc2b1 100644 --- a/apps/docs/src/pages/index.tsx +++ b/apps/docs/src/pages/index.tsx @@ -7,28 +7,60 @@ import clsx from 'clsx'; import Link from '@docusaurus/Link'; import useDocusaurusContext from '@docusaurus/useDocusaurusContext'; import Layout from '@theme/Layout'; +import Heading from '@theme/Heading'; import HomepageFeatures from '@site/src/components/HomepageFeatures'; import styles from './index.module.css'; function HomepageHeader() { - const { siteConfig } = useDocusaurusContext(); return ( -
+
+ +
+ ); +} + + +function TitleBanner(): JSX.Element { + return ( +
-

{siteConfig.title}

-

{siteConfig.tagline}

-
+
+ 🥳 + Jayvee's alpha is now available! + 🎉 +
+ +
+ A domain-specific language for everyone to participate in building data pipelines! +
+ +
- Start data engineering - 5min ⏱️ + Get Started + + Example + + +