Merge pull request #1643 from Kotlin/maven_example

Added Maven project example + Maven setup instructions

Author: AndreiKingsley

.github/workflows/archive-examples.yml

@@ -6,7 +6,8 @@
         - master
       paths:
         - 'examples/android-example/**'
-        - 'examples/kotlin-dataframe-plugin-example/**'
+        - 'examples/kotlin-dataframe-plugin-gradle-example/**'
+        - 'examples/kotlin-dataframe-plugin-maven-example/**'
     workflow_dispatch:
 
   jobs:
@@ -22,10 +23,16 @@
             cd examples/android-example
             zip -r ../../android-example.zip . -x "*.git*" "build/*" ".gradle/*" "*/build/*"
 
-        - name: Create kotlin-dataframe-plugin-example archive
+        - name: Create kotlin-dataframe-plugin-gradle-example archive
           run: |
-            cd examples/kotlin-dataframe-plugin-example
-            zip -r ../../kotlin-dataframe-plugin-example.zip . -x "*.git*" "build/*" ".gradle/*" "*/build/*"
+            cd examples/kotlin-dataframe-plugin-gradle-example
+            zip -r ../../kotlin-dataframe-plugin-gradle-example.zip . -x "*.git*" "build/*" ".gradle/*" "*/build/*" ".idea/*"
+
+        - name: Create kotlin-dataframe-plugin-maven-example archive
+          run: |
+            cd examples/kotlin-dataframe-plugin-maven-example
+            zip -r ../../kotlin-dataframe-plugin-maven-example.zip . -x "*.git*" "target/*" ".idea/*"
+
 
         - name: Checkout example-projects-archives branch
           run: |
@@ -58,10 +65,15 @@
             
             **Download:** [android-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/android-example.zip)
             
-            ### Kotlin DataFrame Plugin Example
-            Example of using the compiler plugin for Kotlin DataFrame.
+            ### Kotlin DataFrame Plugin Gradle Example
+            Example of using the compiler plugin for Kotlin DataFrame in Gradle project.
+            
+            **Download:** [kotlin-dataframe-plugin-gradle-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-gradle-example.zip)
+            
+            ### Kotlin DataFrame Plugin Maven Example
+            Example of using the compiler plugin for Kotlin DataFrame in Gradle project.
             
-            **Download:** [kotlin-dataframe-plugin-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-example.zip)
+            **Download:** [kotlin-dataframe-plugin-maven-example.zip](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-maven-example.zip)
             
             ---
             

README.md

@@ -114,12 +114,12 @@ Or manually specify the version:
 > ```
 
 Refer to the
-[Get started with Kotlin DataFrame in Kotlin Notebook](https://kotlin.github.io/dataframe/gettingstartedkotlinnotebook.html)
+[Setup Kotlin DataFrame in Kotlin Notebook](https://kotlin.github.io/dataframe/setupkotlinnotebook.html)
 for details.
 
 ### Gradle
 
-Add dependencies in the build.gradle.kts script:
+Add dependencies in the `build.gradle.kts` script:
 
 ```kotlin
 dependencies {
@@ -135,18 +135,53 @@ repositories {
 }
 ```
 
+Refer to
+[Get started with Kotlin DataFrame on Gradle](https://kotlin.github.io/dataframe/setupgradle.html)
+for detailed setup instructions (including Groovy DSL).
+
+* You can also check the [Custom Gradle Configuration](https://kotlin.github.io/dataframe/setupcustomgradle.html) if you don't need certain formats as dependencies.
+* For Android projects, see [Setup Kotlin DataFrame on Android](https://kotlin.github.io/dataframe/setupandroid.html).
+* See [IDEA Gradle example projects](examples/idea-examples) 
+and [the Gradle project with the Kotlin DataFrame Compiler plugin](examples/kotlin-dataframe-plugin-gradle-example).
+
 Refer to the
-[Get started with Kotlin DataFrame on Gradle](https://kotlin.github.io/dataframe/gettingstartedgradle.html)
+[Setup Kotlin DataFrame in Kotlin Notebook](https://kotlin.github.io/dataframe/setupkotlinnotebook.html)
 for details.
-Also, check out the [custom setup page](https://kotlin.github.io/dataframe/gettingstartedgradleadvanced.html)
-if you don't need some formats as dependencies,
-for Groovy, and for configurations specific to Android projects.
+
+### Maven
+
+Add dependencies in the `pom.xml` configuration file:
+
+```xml
+<dependency>
+    <groupId>org.jetbrains.kotlinx</groupId>
+    <artifactId>dataframe</artifactId>
+    <version>1.0.0-Beta4</version>
+</dependency>
+```
+
+Make sure that you have `mavenCentral` in the list of repositories:
+
+```xml
+<repositories>
+    <repository>
+        <id>mavenCentral</id>
+        <url>https://repo1.maven.org/maven2/</url>
+    </repository>
+</repositories>
+```
+
+Refer to
+[Get started with Kotlin DataFrame on Maven](https://kotlin.github.io/dataframe/setupmaven.html).
+
+* See [the Maven project with the Kotlin DataFrame Compiler plugin](examples/kotlin-dataframe-plugin-gradle-example).
+
 
 ## Code example
 
 This example of Kotlin DataFrame code with
 the [Compiler Plugin](https://kotlin.github.io/dataframe/compiler-plugin.html) enabled.
-See [the full project](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-example).
+See [the full project](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-gradle-example).
 See also
 [this example in Kotlin Notebook](https://github.com/Kotlin/dataframe/tree/master/examples/notebooks/readme_example.ipynb).
 

build.gradle.kts

@@ -324,7 +324,7 @@ tasks.assemble {
     // subprojects use the Gradle version from the root project, so let's sync them to ensure standalone version will build as well.
     doLast {
         val source = file("gradle/wrapper/gradle-wrapper.properties")
-        listOf("examples/android-example", "examples/kotlin-dataframe-plugin-example").forEach { sub ->
+        listOf("examples/android-example", "examples/kotlin-dataframe-plugin-gradle-example").forEach { sub ->
             val target = file("$sub/gradle/wrapper/gradle-wrapper.properties")
             if (source.readText() != target.readText()) {
                 source.copyTo(target, overwrite = true)

docs/StardustDocs/d.tree

@@ -18,6 +18,7 @@
     <toc-element topic="Setup.md" accepts-web-file-names="gettingstarted">
         <toc-element topic="SetupKotlinNotebook.md" accepts-web-file-names="gettingstartedkotlinnotebook.html"/>
         <toc-element topic="SetupGradle.md" accepts-web-file-names="gettingstartedgradle.html"/>
+        <toc-element topic="SetupMaven.md"/>
         <toc-element topic="SetupJupyter.md" accepts-web-file-names="gettingstartedjupyternotebook.html"/>
         <toc-element topic="SetupDatalore.md" accepts-web-file-names="gettingstarteddatalore.html"/>
         <toc-element topic="SetupAndroid.md"/>

docs/StardustDocs/topics/Compiler-Plugin.md

@@ -55,16 +55,15 @@ Setup library dependency:
 implementation("org.jetbrains.kotlinx:dataframe:%dataFrameVersion%")
 ```
 
-Add this line to `gradle.properties`:
+Due to the [known issue](https://youtrack.jetbrains.com/issue/KT-66735), incremental compilation must be disabled for now.
+Add the following line to your `gradle.properties` file:
+
 ```properties
 kotlin.incremental=false
 ```
 
 Sync the project.
 
-Disabling incremental compilation will no longer be necessary
-when https://youtrack.jetbrains.com/issue/KT-66735 is resolved.
-
 </tab>
 
 <tab title="Maven">
@@ -164,6 +163,8 @@ fun main() {
 
 ## Examples
 
-* [Kotlin DataFrame in the IntelliJ IDEA project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-example)  
-  — an IntelliJ IDEA project showcasing simple DataFrame expressions using the Compiler Plugin.
+* [Kotlin DataFrame in the IntelliJ IDEA Gradle project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example)  
+  — an IntelliJ IDEA Gradle project showcasing simple DataFrame expressions using the Compiler Plugin.
+* [Kotlin DataFrame in the IntelliJ IDEA Maven project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-maven-example)   
+  — an IntelliJ IDEA Maven project showcasing simple DataFrame expressions using the Compiler Plugin.
 * [](compilerPluginExamples.md) — few examples of Compiler Plugin usages.

docs/StardustDocs/topics/compilerPluginExamples.md

@@ -3,7 +3,8 @@
 This page provides a few examples that you can copy directly to your project.
 [Schema info](staticInterpretation.md#schema-info) will be a convenient way to observe the result of different operations.
 
-> See also an [IntelliJ IDEA project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-example), 
+> See also an 
+> [IntelliJ IDEA project example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example), 
 > showcasing simple DataFrame expressions using the Compiler Plugin.
 
 ### Example 1

docs/StardustDocs/topics/extensionPropertiesApi.md

@@ -159,7 +159,7 @@ df.rename { name }.into("firstName")
     .filter { firstName == "Nikita" }
 ```
 
-See [Compiler Plugin Example](https://github.com/Kotlin/dataframe/tree/plugin_example/examples/kotlin-dataframe-plugin-example) 
+See [Compiler Plugin Example](https://github.com/Kotlin/dataframe/tree/plugin_example/examples/kotlin-dataframe-plugin-gradle-example) 
 IDEA project with basic Extension Properties API examples.
 </tab>
 </tabs>

docs/StardustDocs/topics/guides/Guides-And-Examples.md

@@ -70,8 +70,13 @@ and make working with your data both convenient and type-safe.
 
 Explore our extensive collection of practical examples and real-world analytics workflows.
 
-* [Kotlin DataFrame Compiler Plugin Example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-example)  
-  — a simple project demonstrating the usage of the [compiler plugin](Compiler-Plugin.md),  
+* [Kotlin DataFrame Compiler Plugin Gradle Example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example)  
+  — a simple Gradle project demonstrating the usage of the [compiler plugin](Compiler-Plugin.md),  
+  showcasing DataFrame expressions with [extension properties](extensionPropertiesApi.md)  
+  that are generated on-the-fly in the IDEA project.
+
+* [Kotlin DataFrame Compiler Plugin Maven Example](https://github.com/Kotlin/dataframe/blob/master/examples/kotlin-dataframe-plugin-gradle-example)  
+  — a simple Maven project demonstrating the usage of the [compiler plugin](Compiler-Plugin.md),  
   showcasing DataFrame expressions with [extension properties](extensionPropertiesApi.md)  
   that are generated on-the-fly in the IDEA project.
 

docs/StardustDocs/topics/setup/Setup.md

@@ -25,6 +25,9 @@ for [data analysis](https://kotlinlang.org/docs/data-analysis-overview.html).
 - [**Setup in Gradle**](SetupGradle.md) — add Kotlin DataFrame to your Gradle project for convenient data handling 
 in your Kotlin applications.
 
+- [**Setup in Maven**](SetupMaven.md) — add Kotlin DataFrame to your Maven project for convenient data handling
+  in your Kotlin applications.
+
 - [**Setup on Android**](SetupAndroid.md) — use Kotlin DataFrame in your Android apps to simplify local data processing 
 and transformation.
 

docs/StardustDocs/topics/setup/SetupGradle.md

@@ -121,13 +121,21 @@ plugins {
 </tab>
 </tabs>
 
-Due to [this issue](https://youtrack.jetbrains.com/issue/KT-66735), incremental compilation must be disabled for now.
+Due to the [known issue](https://youtrack.jetbrains.com/issue/KT-66735), incremental compilation must be disabled for now.
 Add the following line to your `gradle.properties` file:
 
 ```properties
 kotlin.incremental=false
 ```
 
+## Project Example
+
+See [the Gradle example project with the Kotlin DataFrame Compiler Plugin enabled on GitHub](https://github.com/Kotlin/dataframe/tree/master/examples/kotlin-dataframe-plugin-gradle-example).
+
+You can also
+[download this project](https://github.com/Kotlin/dataframe/raw/example-projects-archives/kotlin-dataframe-plugin-gradle-example.zip).
+
+
 ## Next Steps
 
 * Once you’ve set up Kotlin DataFrame in your Gradle project, continue with the [](quickstart.md)