Skip to content

Commit

Permalink
feat: taking Share Kotlin Notebook out of get started. (#4462)
Browse files Browse the repository at this point in the history
* Take Share Kotlin Notebook out of get started.

This PR contains updates to the Data analysis section to test improvement in user navigation according to GA analysis.

* Adding links to improve navigation within our docs

* Daniel review
  • Loading branch information
AlejandraPedroza authored Dec 11, 2024
1 parent b91dba0 commit 832b050
Show file tree
Hide file tree
Showing 14 changed files with 44 additions and 63 deletions.
4 changes: 2 additions & 2 deletions docs/kr.tree
Original file line number Diff line number Diff line change
Expand Up @@ -162,9 +162,9 @@
<toc-element toc-title="Introduction to Kotlin Notebook" topic="get-started-with-kotlin-notebooks.md"/>
<toc-element toc-title="1. Set up an environment" topic="kotlin-notebook-set-up-env.md"/>
<toc-element toc-title="2. Create your first Kotlin Notebook" topic="kotlin-notebook-create.md"/>
<toc-element toc-title="3. Add dependencies to a Kotlin Notebook" topic="kotlin-notebook-add-dependencies.md"/>
<toc-element toc-title="4. Share a Kotlin Notebook" topic="kotlin-notebook-share.md"/>
<toc-element toc-title="3. Add dependencies to your Kotlin Notebook" topic="kotlin-notebook-add-dependencies.md"/>
</toc-element>
<toc-element toc-title="Share your Kotlin Notebook" topic="kotlin-notebook-share.md"/>
<toc-element toc-title="Output formats in Kotlin notebooks" topic="data-analysis-notebooks-output-formats.md"/>
<toc-element toc-title="Working with data sources">
<toc-element topic="data-analysis-work-with-data-sources.md"/>
Expand Down
8 changes: 4 additions & 4 deletions docs/topics/data-analysis-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ Kotlin DataFrame libraries to complete different data-related tasks.

## What's next

* [Get started with Kotlin Notebook.](get-started-with-kotlin-notebooks.md)
* [Retrieve and transform data using the Kotlin DataFrame library.](data-analysis-work-with-data-sources.md)
* [Visualize data using the Kandy library.](data-analysis-visualization.md)
* [Learn more about Kotlin and Java libraries for data analysis.](data-analysis-libraries.md)
* [Get started with Kotlin Notebook](get-started-with-kotlin-notebooks.md)
* [Retrieve and transform data using the Kotlin DataFrame library](data-analysis-work-with-data-sources.md)
* [Visualize data using the Kandy library](data-analysis-visualization.md)
* [Learn more about Kotlin and Java libraries for data analysis](data-analysis-libraries.md)
8 changes: 4 additions & 4 deletions docs/topics/data-analysis/data-analysis-connect-to-db.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -180,6 +180,6 @@ occurring first names of actors:

## What's next

* Explore data visualization using the [Kandy library](https://kotlin.github.io/kandy/examples.html).
* Find additional information about data visualization in [Data visualization in Kotlin Notebook with Kandy](data-analysis-visualization.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).
* Explore data visualization using the [Kandy library](https://kotlin.github.io/kandy/examples.html)
* Find additional information about data visualization in [Data visualization in Kotlin Notebook with Kandy](data-analysis-visualization.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)
2 changes: 1 addition & 1 deletion docs/topics/data-analysis/data-analysis-libraries.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -289,5 +289,6 @@ 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)
* [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)
10 changes: 5 additions & 5 deletions docs/topics/data-analysis/data-analysis-visualization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -162,7 +162,7 @@ Here's the result:

## What's next

* Explore more chart examples in the [Kandy library documentation](https://kotlin.github.io/kandy/examples.html).
* Explore more advanced plotting options in the [Lets-Plot library documentation](lets-plot.md).
* Find additional information about creating, exploring, and managing data frames in the [Kotlin DataFrame library documentation](https://kotlin.github.io/dataframe/info.html).
* Learn more about data visualization in Kotlin Notebook in this [YouTube video]( https://www.youtube.com/watch?v=m4Cqz2_P9rI&t=4s).
* Explore more chart examples in the [Kandy library documentation](https://kotlin.github.io/kandy/examples.html)
* Explore more advanced plotting options in the [Lets-Plot library documentation](lets-plot.md)
* Find additional information about creating, exploring, and managing data frames in the [Kotlin DataFrame library documentation](https://kotlin.github.io/dataframe/info.html)
* Learn more about data visualization in Kotlin Notebook in this [YouTube video]( https://www.youtube.com/watch?v=m4Cqz2_P9rI&t=4s)
8 changes: 4 additions & 4 deletions docs/topics/data-analysis/data-analysis-work-with-api.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -213,6 +213,6 @@ For more advanced techniques, see the [Kotlin DataFrame documentation](https://k

## What's next

* Explore data visualization using the [Kandy library](https://kotlin.github.io/kandy/examples.html).
* Find additional information about data visualization in [Data visualization in Kotlin Notebook with Kandy](data-analysis-visualization.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).
* Explore data visualization using the [Kandy library](https://kotlin.github.io/kandy/examples.html)
* Find additional information about data visualization in [Data visualization in Kotlin Notebook with Kandy](data-analysis-visualization.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)
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -183,6 +183,6 @@ table and open it in your default web browser:

## What's next

* Explore data visualization using the [Kandy library](https://kotlin.github.io/kandy/examples.html).
* Find additional information about data visualization in [Data visualization in Kotlin Notebook with Kandy](data-analysis-visualization.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).
* Explore data visualization using the [Kandy library](https://kotlin.github.io/kandy/examples.html)
* Find additional information about data visualization in [Data visualization in Kotlin Notebook with Kandy](data-analysis-visualization.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)
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -12,8 +12,6 @@ Get to know Kotlin Notebook by completing these steps:

![Third step](icon-3.svg){width=25}{type="joined"} [Add dependencies to your Kotlin Notebook](kotlin-notebook-add-dependencies.md)

![Fourth step](icon-4.svg){width=25}{type="joined"} [Share your Kotlin Notebook](kotlin-notebook-share.md)

## Next step

Start by setting up an environment for working with Kotlin Notebook:
Expand Down
19 changes: 8 additions & 11 deletions docs/topics/data-analysis/kotlin-notebook-add-dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
<p>This is the third part of the <strong>Getting started with Kotlin Notebook</strong> tutorial. Before proceeding, make sure you've completed the previous steps.</p>
<p><img src="icon-1-done.svg" width="20" alt="First step"/> <a href="kotlin-notebook-set-up-env.md">Set up an environment</a><br/>
<img src="icon-2-done.svg" width="20" alt="Second step"/> <a href="kotlin-notebook-create.md">Create a Kotlin Notebook</a><br/>
<img src="icon-3.svg" width="20" alt="Third step"/> <strong>Add dependencies to a Kotlin Notebook</strong><br/>
<img src="icon-4-todo.svg" width="20" alt="Fourth step"/> Share a Kotlin Notebook<br/>
<img src="icon-3.svg" width="20" alt="Third step"/> <strong>Add dependencies to a Kotlin Notebook</strong><br/>
</p>
</tldr>

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.
Expand All @@ -18,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
Expand Down Expand Up @@ -109,11 +108,9 @@ The resulting chart:
Congratulations on adding and utilizing these libraries in your Kotlin Notebook!
This is just a glimpse into what you can achieve with Kotlin Notebook and its [supported libraries](data-analysis-libraries.md).

For a more extensive guide using the Kotlin DataFrame library, see
[Retrieve data from files](data-analysis-work-with-data-sources.md), and explore [Data visualization in Kotlin Notebook with Kandy](data-analysis-visualization.md) for advanced data visualization.
## What's next
## Next step

In the next part of the tutorial, you will learn how to share a Kotlin Notebook.

**[Proceed to the next chapter](kotlin-notebook-share.md)**
* Learn how to [share your Kotlin Notebook](kotlin-notebook-share.md)
* 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 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)
5 changes: 2 additions & 3 deletions docs/topics/data-analysis/kotlin-notebook-create.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
<p>This is the second part of the <strong>Getting started with Kotlin Notebook</strong> tutorial. Before proceeding, make sure you've completed the previous step.</p>
<p><img src="icon-1-done.svg" width="20" alt="First step"/> <a href="kotlin-notebook-set-up-env.md">Set up an environment</a><br/>
<img src="icon-2.svg" width="20" alt="Second step"/> <strong>Create a Kotlin Notebook</strong><br/>
<img src="icon-3-todo.svg" width="20" alt="Third step"/> Add dependencies to a Kotlin Notebook<br/>
<img src="icon-4-todo.svg" width="20" alt="Fourth step"/> Share a Kotlin Notebook<br/>
<img src="icon-3-todo.svg" width="20" alt="Third step"/> Add dependencies to a Kotlin Notebook<br/>
</p>
</tldr>

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

Expand Down
5 changes: 2 additions & 3 deletions docs/topics/data-analysis/kotlin-notebook-set-up-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
<p>This is the first part of the <strong>Getting started with Kotlin Notebook</strong> tutorial:</p>
<p><img src="icon-1.svg" width="20" alt="First step"/> <strong>Set up an environment</strong><br/>
<img src="icon-2-todo.svg" width="20" alt="Second step"/> Create a Kotlin Notebook<br/>
<img src="icon-3-todo.svg" width="20" alt="Third step"/> Add dependencies to a Kotlin Notebook<br/>
<img src="icon-4-todo.svg" width="20" alt="Fourth step"/> Share a Kotlin Notebook<br/>
<img src="icon-3-todo.svg" width="20" alt="Third step"/> Add dependencies to a Kotlin Notebook<br/>
</p>
</tldr>

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

Expand Down
21 changes: 4 additions & 17 deletions docs/topics/data-analysis/kotlin-notebook-share.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,6 @@
[//]: # (title: Share your Kotlin Notebook)

<tldr>
<p>This is the fourth part of the <strong>Getting started with Kotlin Notebook</strong> tutorial. Before proceeding, make sure you've completed the previous steps.</p>
<p><img src="icon-1-done.svg" width="20" alt="First step"/> <a href="kotlin-notebook-set-up-env.md">Set up an environment</a><br/>
<img src="icon-2-done.svg" width="20" alt="Second step"/> <a href="kotlin-notebook-create.md">Create a Kotlin Notebook</a><br/>
<img src="icon-3-done.svg" width="20" alt="Third step"/> <a href="kotlin-notebook-add-dependencies.md">Add dependencies to a Kotlin Notebook</a><br/>
<img src="icon-4.svg" width="20" alt="Fourth step"/> <strong>Share a Kotlin Notebook</strong><br/>
</p>
</tldr>

Now that you have created your first Kotlin Notebook, you are ready to share your work with others!

## Share a 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:
Expand All @@ -28,6 +15,6 @@ We recommend the following platforms to share Kotlin notebooks:

## What's next

* Explore data visualization using the [Kandy library](data-analysis-visualization.md).
* Learn about retrieving data from files, web sources, or databases in [Working with data sources](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).
* Explore data visualization using the [Kandy library](data-analysis-visualization.md)
* Learn about retrieving data from files, web sources, or databases in [Working with data sources](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)
2 changes: 1 addition & 1 deletion docs/topics/kotlin-notebook-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down

0 comments on commit 832b050

Please sign in to comment.