From 398768252aac81f9417c5637de202534baf565d5 Mon Sep 17 00:00:00 2001 From: alepedroza <39709865+AlejandraPedroza@users.noreply.github.com> Date: Thu, 17 Oct 2024 15:41:01 +0200 Subject: [PATCH] Adding links to improve navigation within our docs --- docs/topics/data-analysis/data-analysis-connect-to-db.md | 2 +- docs/topics/data-analysis/data-analysis-libraries.md | 2 +- .../data-analysis-notebooks-output-formats.md | 9 +++++---- docs/topics/data-analysis/data-analysis-visualization.md | 2 +- docs/topics/data-analysis/data-analysis-work-with-api.md | 2 +- .../data-analysis-work-with-data-sources.md | 2 +- .../data-analysis/get-started-with-kotlin-notebooks.md | 2 +- .../data-analysis/kotlin-notebook-add-dependencies.md | 6 +++--- docs/topics/data-analysis/kotlin-notebook-create.md | 2 +- docs/topics/data-analysis/kotlin-notebook-set-up-env.md | 2 +- docs/topics/data-analysis/kotlin-notebook-share.md | 2 +- docs/topics/kotlin-notebook-overview.md | 2 +- 12 files changed, 18 insertions(+), 17 deletions(-) diff --git a/docs/topics/data-analysis/data-analysis-connect-to-db.md b/docs/topics/data-analysis/data-analysis-connect-to-db.md index 0833c1e222d..88c3ed07d49 100644 --- a/docs/topics/data-analysis/data-analysis-connect-to-db.md +++ b/docs/topics/data-analysis/data-analysis-connect-to-db.md @@ -1,6 +1,6 @@ [//]: # (title: Connect and retrieve data from databases) -Kotlin Notebook offers capabilities for connecting to and retrieving data from various types of SQL databases, such as +[Kotlin Notebook](kotlin-notebook-overview.md) offers capabilities for connecting to and retrieving data from various types of SQL databases, such as MariaDB, PostgreSQL, MySQL, and SQLite. Utilizing the [Kotlin DataFrame library](https://kotlin.github.io/dataframe/gettingstarted.html), Kotlin Notebook can establish connections to databases, execute SQL queries, and import the results for further operations. diff --git a/docs/topics/data-analysis/data-analysis-libraries.md b/docs/topics/data-analysis/data-analysis-libraries.md index 0ea8b435abd..c61ce9e7463 100644 --- a/docs/topics/data-analysis/data-analysis-libraries.md +++ b/docs/topics/data-analysis/data-analysis-libraries.md @@ -5,7 +5,7 @@ different tasks in the data pipeline. In addition to its own libraries, Kotlin is 100% interoperable with Java. This interoperability helps to leverage the entire ecosystem of tried-and-true Java libraries with excellent performance. With this perk, you can easily use either Kotlin -or Java libraries when working on Kotlin data projects. +or Java libraries when working on [Kotlin data projects](data-analysis-overview.md). ## Kotlin libraries diff --git a/docs/topics/data-analysis/data-analysis-notebooks-output-formats.md b/docs/topics/data-analysis/data-analysis-notebooks-output-formats.md index 30ed9320cc9..64956dc30c7 100644 --- a/docs/topics/data-analysis/data-analysis-notebooks-output-formats.md +++ b/docs/topics/data-analysis/data-analysis-notebooks-output-formats.md @@ -1,6 +1,6 @@ [//]: # (title: Output formats supported by Kotlin Notebook) -Kotlin Notebook supports a variety of output types, including text, HTML, and images. With the help of external libraries, +[Kotlin Notebook](kotlin-notebook-overview.md) supports a variety of output types, including text, HTML, and images. With the help of external libraries, you can expand your output options and visualize your data with charts, spreadsheets, and more. Each output is a JSON object that maps the [Jupiter MIME type](https://jupyterlab.readthedocs.io/en/latest/user/file_formats.html) @@ -288,6 +288,7 @@ You can create various charts directly in your Kotlin Notebook to visualize your ## What's next -* [Visualize data using the DataFrame and Kandy libraries](data-analysis-visualization.md) -* [Retrieve data from the CSV and JSON files](data-analysis-work-with-data-sources.md) -* [Check out the list of recommended libraries](data-analysis-libraries.md) \ No newline at end of file +* [Visualize data using the DataFrame and Kandy libraries](data-analysis-visualization.md). +* [Learn more about rendering and displaying rich output in Kotlin Notebook](https://www.jetbrains.com/help/idea/kotlin-notebook.html#render-rich-output). +* [Retrieve data from the CSV and JSON files](data-analysis-work-with-data-sources.md). +* [Check out the list of recommended libraries](data-analysis-libraries.md). \ No newline at end of file diff --git a/docs/topics/data-analysis/data-analysis-visualization.md b/docs/topics/data-analysis/data-analysis-visualization.md index bf8395586ff..93b1aa34e64 100644 --- a/docs/topics/data-analysis/data-analysis-visualization.md +++ b/docs/topics/data-analysis/data-analysis-visualization.md @@ -3,7 +3,7 @@ Kotlin offers an all-in-one-place solution for powerful and flexible data visualization, providing an intuitive way to present and explore data before diving into complex models. -This tutorial demonstrates how to create different chart types in IntelliJ IDEA using [Kotlin Notebook](https://plugins.jetbrains.com/plugin/16340-kotlin-notebook) with +This tutorial demonstrates how to create different chart types in IntelliJ IDEA using [Kotlin Notebook](kotlin-notebook-overview.md) with the [Kandy](https://kotlin.github.io/kandy/welcome.html) and [Kotlin DataFrame](https://kotlin.github.io/dataframe/gettingstarted.html) libraries. ## Before you start diff --git a/docs/topics/data-analysis/data-analysis-work-with-api.md b/docs/topics/data-analysis/data-analysis-work-with-api.md index d1bb7a724f2..1267239356a 100644 --- a/docs/topics/data-analysis/data-analysis-work-with-api.md +++ b/docs/topics/data-analysis/data-analysis-work-with-api.md @@ -1,6 +1,6 @@ [//]: # (title: Retrieve data from web sources and APIs) -Kotlin Notebook provides a powerful platform for accessing and manipulating data from various web sources and APIs. +[Kotlin Notebook](kotlin-notebook-overview.md) provides a powerful platform for accessing and manipulating data from various web sources and APIs. It simplifies data extraction and analysis tasks by offering an iterative environment where every step can be visualized for clarity. This makes it particularly useful when exploring APIs you are not familiar with. diff --git a/docs/topics/data-analysis/data-analysis-work-with-data-sources.md b/docs/topics/data-analysis/data-analysis-work-with-data-sources.md index dacbd5ae5b9..ae2aa26dc7b 100644 --- a/docs/topics/data-analysis/data-analysis-work-with-data-sources.md +++ b/docs/topics/data-analysis/data-analysis-work-with-data-sources.md @@ -1,6 +1,6 @@ [//]: # (title: Retrieve data from files) -Kotlin Notebook, coupled with the [Kotlin DataFrame library](https://kotlin.github.io/dataframe/gettingstarted.html), enables +[Kotlin Notebook](kotlin-notebook-overview.md), coupled with the [Kotlin DataFrame library](https://kotlin.github.io/dataframe/gettingstarted.html), enables you to work with both non-structured and structured data. This combination offers the flexibility to transform non-structured data, such as data found in TXT files, into structured datasets. diff --git a/docs/topics/data-analysis/get-started-with-kotlin-notebooks.md b/docs/topics/data-analysis/get-started-with-kotlin-notebooks.md index 57053505617..7eee9cb6929 100644 --- a/docs/topics/data-analysis/get-started-with-kotlin-notebooks.md +++ b/docs/topics/data-analysis/get-started-with-kotlin-notebooks.md @@ -1,6 +1,6 @@ [//]: # (title: Get started with Kotlin Notebook) -Kotlin Notebook is an interactive tool that lets you mix code, visuals, and markdown in one document. +[Kotlin Notebook](kotlin-notebook-overview.md) is an interactive tool that lets you mix code, visuals, and markdown in one document. You can use notebooks to write and execute code in sections known as _code cells_, see the results instantly, and write down your thoughts. This setup makes it an excellent tool for rapid prototyping, analytics, and data science. diff --git a/docs/topics/data-analysis/kotlin-notebook-add-dependencies.md b/docs/topics/data-analysis/kotlin-notebook-add-dependencies.md index 5a92a340a3e..d72b19205e2 100644 --- a/docs/topics/data-analysis/kotlin-notebook-add-dependencies.md +++ b/docs/topics/data-analysis/kotlin-notebook-add-dependencies.md @@ -8,7 +8,7 @@

-You've already created your first Kotlin Notebook! Now let's learn how to add dependencies to libraries, which +You've already created your first [Kotlin Notebook](kotlin-notebook-overview.md)! Now let's learn how to add dependencies to libraries, which is necessary to unlock advanced features. > The Kotlin standard library can be used out of the box, so you don't have to import it. @@ -17,7 +17,7 @@ is necessary to unlock advanced features. You can load any library from the Maven repository by specifying its coordinates using Gradle-style syntax in any code cell. -However, Kotlin Notebook has a simplified method to load popular libraries in the form of the `%use` statement: +However, Kotlin Notebook has a simplified method to load popular libraries in the form of the [`%use` statement](https://www.jetbrains.com/help/idea/kotlin-notebook.html#import-libraries): ```kotlin // Replace libraryName with the library dependency you want to add @@ -111,5 +111,5 @@ This is just a glimpse into what you can achieve with Kotlin Notebook and its [s ## What's next * See more details about [adding dependencies to your Kotlin Notebook](https://www.jetbrains.com/help/idea/kotlin-notebook.html#add-dependencies). -* For a more extensive guide using the Kotlin DataFrame library, see [Retrieve data from files](data-analysis-work-with-data-sources.md) +* For a more extensive guide using the Kotlin DataFrame library, see [Retrieve data from files](data-analysis-work-with-data-sources.md). * For an extensive overview of tools and resources available for data science and analysis in Kotlin, see [Kotlin and Java libraries for data analysis](data-analysis-libraries.md). diff --git a/docs/topics/data-analysis/kotlin-notebook-create.md b/docs/topics/data-analysis/kotlin-notebook-create.md index e39153575f1..e0d67fbc1dc 100644 --- a/docs/topics/data-analysis/kotlin-notebook-create.md +++ b/docs/topics/data-analysis/kotlin-notebook-create.md @@ -8,7 +8,7 @@

-Here, you will learn how to create your first Kotlin Notebook, perform simple operations, and run code cells. +Here, you will learn how to create your first [Kotlin Notebook](kotlin-notebook-overview.md), perform simple operations, and run code cells. ## Create an empty project diff --git a/docs/topics/data-analysis/kotlin-notebook-set-up-env.md b/docs/topics/data-analysis/kotlin-notebook-set-up-env.md index 2cfef3d87bd..895c99220de 100644 --- a/docs/topics/data-analysis/kotlin-notebook-set-up-env.md +++ b/docs/topics/data-analysis/kotlin-notebook-set-up-env.md @@ -8,7 +8,7 @@

-Before you create your first Kotlin Notebook, you need to set up an environment. +Before you create your first [Kotlin Notebook](kotlin-notebook-overview.md), you need to set up an environment. ## Set up the environment diff --git a/docs/topics/data-analysis/kotlin-notebook-share.md b/docs/topics/data-analysis/kotlin-notebook-share.md index d27ba563958..ba0f939e8e0 100644 --- a/docs/topics/data-analysis/kotlin-notebook-share.md +++ b/docs/topics/data-analysis/kotlin-notebook-share.md @@ -1,6 +1,6 @@ [//]: # (title: Share your Kotlin Notebook) -To share a Kotlin Notebook, just upload it to any notebook web viewer because Kotlin notebooks follow the +To share a [Kotlin Notebook](kotlin-notebook-overview.md), you can just upload it to any notebook web viewer because [Kotlin notebooks](data-analysis-overview.md#notebooks) follow the universal Jupyter format. We recommend the following platforms to share Kotlin notebooks: diff --git a/docs/topics/kotlin-notebook-overview.md b/docs/topics/kotlin-notebook-overview.md index 8c6b1e4ad4d..a90d4b010bd 100644 --- a/docs/topics/kotlin-notebook-overview.md +++ b/docs/topics/kotlin-notebook-overview.md @@ -19,7 +19,7 @@ The Kotlin Notebook plugin comes with [various features](https://www.jetbrains.c * Getting insights for debugging with error messages and traceback Kotlin Notebook is based on our [Kotlin Kernel for Jupyter Notebooks](https://github.com/Kotlin/kotlin-jupyter?tab=readme-ov-file#kotlin-kernel-for-ipythonjupyter), -making it easy to integrate with other [Kotlin notebook solutions](https://kotlinlang.org/docs/data-analysis-overview.html#notebooks). +making it easy to integrate with other [Kotlin notebook solutions](data-analysis-overview.md#notebooks). Without compatibility issues, you can effortlessly share your work among Kotlin Notebook, [Datalore](https://datalore.jetbrains.com/), and [Kotlin-Jupyter Notebook](https://github.com/Kotlin/kotlin-jupyter).