Skip to content

Commit 09f1bcc

Browse files
Merge pull request #1323 from Kotlin/docs_update
Docs small fixes
2 parents 03190bb + 6aa49bd commit 09f1bcc

File tree

9 files changed

+48
-0
lines changed

9 files changed

+48
-0
lines changed

docs/StardustDocs/d.tree

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,9 @@
188188
<toc-element topic="jupyterRendering.md"/>
189189
</toc-element>
190190
</toc-element>
191+
<toc-element topic="Data-Sources.md" hidden="true">
192+
<toc-element topic="Integrations.md" hidden="true"/>
193+
</toc-element>
191194
<toc-element topic="_shadow_resources.md" hidden="true"/>
192195
<toc-element topic="Support.md"/>
193196
<toc-element topic="FAQ.md"/>

docs/StardustDocs/topics/FAQ.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,14 @@ and examples with beautiful [Kandy](https://kotlin.github.io/kandy) geo visualiz
172172

173173
## What is the difference between Compiler Plugin, Gradle Plugin, and KSP Plugin?
174174

175+
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated
176+
> in future releases.
177+
> The KSP plugin doesn't work for now.
178+
>
179+
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead
180+
> of relying on the plugins.
181+
{style="warning"}
182+
175183
All these plugins relate to working with [dataframe schemas](schemas.md), but they serve different purposes:
176184

177185
- **[Gradle Plugin](DataSchemaGenerationGradle.md)** and **[KSP Plugin](https://github.com/Kotlin/dataframe/tree/master/plugins/symbol-processor)**

docs/StardustDocs/topics/concepts/DataSchemaGenerationGradle.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
11
[//]: # (title: Data Shemas Generation in Gradle)
22

3+
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
4+
>
5+
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
6+
{style="warning"}
7+
38
This page describes the Gradle plugin that generates `@DataSchema` from data samples.
49
```Kotlin
510
id("org.jetbrains.kotlinx.dataframe") version "%dataFrameVersion%"

docs/StardustDocs/topics/concepts/schemasGradle.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->
44

5+
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
6+
>
7+
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
8+
{style="warning"}
9+
510
In Gradle projects, the Kotlin DataFrame library provides
611

712
1. Annotation processing for generation of extension properties

docs/StardustDocs/topics/concepts/schemasImportOpenApiGradle.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->
44

5+
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
6+
>
7+
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
8+
{style="warning"}
9+
510
<warning>
611
OpenAPI 3.0.0 schema support is marked as experimental. It might change or be removed in the future.
712
</warning>

docs/StardustDocs/topics/concepts/schemasImportSqlGradle.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.Schemas-->
44

5+
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
6+
>
7+
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
8+
{style="warning"}
9+
510
Each SQL database contains the metadata for all the tables.
611
This metadata could be used for the schema generation.
712

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Data Sources
2+
3+
> This topic is not ready yet.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Integrations
2+
3+
> This topic is not ready yet.

docs/StardustDocs/topics/gettingStarted/Modules.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,11 @@ Published as a Kotlin official plugin.
508508

509509
#### `kotlinx.dataframe` – Gradle Plugin {id="kotlinx.dataframe"}
510510

511+
> The current Gradle plugin is **under consideration for deprecation** and may be officially marked as deprecated in future releases.
512+
>
513+
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
514+
{style="warning"}
515+
511516
The Gradle plugin allows generating [data schemas](schemas.md) from samples of data
512517
(of supported formats) like JSON, CSV, Excel files, or URLs, as well as from data fetched from SQL databases
513518
using Gradle.
@@ -517,6 +522,7 @@ and usage instructions in Gradle projects.
517522

518523
> By default, the Gradle plugin also applies the [KSP plugin](#ksp-plugin).
519524
525+
520526
<tabs>
521527
<tab title="Kotlin DSL">
522528

@@ -540,6 +546,11 @@ plugins {
540546

541547
#### `kotlinx.dataframe:symbol-processor-all` – KSP Plugin {id="ksp-plugin"}
542548

549+
> Doesn't work for now.
550+
>
551+
> At the moment, **[data schema generation is handled via dedicated methods](DataSchemaGenerationMethods.md)** instead of relying on the plugin.
552+
{style="warning"}
553+
543554
The Gradle plugin allows generating [data schemas](schemas.md) from samples of data
544555
(of supported formats) like JSON, CSV, Excel files, or URLs, as well as from data fetched from SQL databases
545556
using Kotlin Symbol Processing (KSP).

0 commit comments

Comments
 (0)