Skip to content

Commit

Permalink
Release 08.12.2023
Browse files Browse the repository at this point in the history
* Added Getting started with DataLens.
* Fixes and improvements.
* Translations updated.
  • Loading branch information
DataUI VCS Robot authored and dtikhonova committed Dec 8, 2023
1 parent 44e0936 commit c3dd715
Show file tree
Hide file tree
Showing 1,298 changed files with 45,099 additions and 43,570 deletions.
2 changes: 1 addition & 1 deletion .yfmlint
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
log-levels:
YFM001: 'disabled'
YFM001: 'disabled'
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,23 @@
## Getting Started
# DataLens docs

Build .md doc sources into .html static files
Welcome to the datalens-tech/docs repository. Here you can suggest additions and fixes for the DataLens [documentation](https://datalens.tech/docs) or make them by yourself.

## Making edits

You can report bugs and submit suggestions as GitHub issues in this repository. To make edits, create a pull request from your fork. Edits will be reviewed by the repository owner.

## About docs

Our documentation is developed using [Yandex Flavored Markdown](https://diplodoc.com/docs/en/index-yfm).

## Building docs

Build .md doc sources into .html static files.

```bash
npm run build
```
Post-build script for fixing metadata tags and add header
Post-build script for fixing metadata tags and adding headers.

```bash
npm run post-build
Expand Down
11 changes: 11 additions & 0 deletions en/_assets/datalens/angle-down.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions en/_assets/datalens/chart.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions en/_assets/datalens/dashboard-0523.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions en/_assets/datalens/datasets.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_assets/datalens/operations/widget-select.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_assets/datalens/parameters/date-interval.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en/_assets/datalens/parameters/iso-date.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions en/_assets/datalens/save-button.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed en/_assets/share.png
Binary file not shown.
2 changes: 1 addition & 1 deletion en/_includes/datalens/datalens-category-text.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
If the values of the categories contain a large amount of text, try to reduce it. Then the signatures on the diagram will look more accurate. You can use string functions in the calculated fields or conditional operators [CASE](../../function-ref/CASE.md).
If the values of the categories contain a large amount of text, try to reduce it. Then the signatures on the diagram will look more accurate. You can use string functions in the calculated fields or conditional operators [CASE](../../datalens/function-ref/CASE.md).
4 changes: 2 additions & 2 deletions en/_includes/datalens/datalens-chart-null-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@ If the source data includes a row where the measure value is `null`, this point

You can use settings for chart sections to show null values:

1. In the section with a measure whose values you want to show, in the upper-right corner, click ![image](../../_assets/datalens/gear.svg) (the icon appears when you hover over the section).s/datalens/gear.svg) (the icon appears when you hover over the section).
1. In the section with a measure whose values you want to show, in the upper-right corner, click ![image](../../_assets/datalens/gear.svg) (the icon appears when you hover over the section).
1. In **Empty values (null)**, select `Display as 0`.
1. Click **Apply**.

Now, the chart will use `0` instead of `null`.

If a row is missing in the source data, the chart section settings won't affect the measure display on the chart. For example, if the source data doesn't have a row with a certain date (`20.07.2022`), nothing will be shown for this date on the chart.

For more information, see [{#T}](../../operations/chart/chart-null-settings.md).
For more information, see [{#T}](../../datalens/operations/chart/chart-null-settings.md).
11 changes: 11 additions & 0 deletions en/_includes/datalens/datalens-chart-parameters-example.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{% cut "Example of using parameters in a chart" %}

One chart is added three times to the **Ticket SLA statistics** dashboard:

* **Total of tickets created**: The chart is added with no parameter. Data is displayed for all tickets.
* **Closed without SLA violation**: The settings of the chart on the dashboard have the `sla_failed` parameter added with the `not_failed` value. Data is only displayed for the tickets closed with no SLA violations.
* **Closed with violations**: The settings of the chart on the dashboard have the `sla_failed` parameter added with the `failed` value. Data is only displayed for the tickets closed with SLA violations.

![image](../../_assets/datalens/parameters/chart-parameters.png)

{% endcut %}
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
* **Hostname**: Specify the path to a master host or a PostgreSQL master host IP address. You can specify multiple hosts in a comma-separated list. If you are unable to connect to the first host, DataLens will select the next one from the list.
* **Port**: Specify the PostgreSQL connection port. In DataLens, the default port is 6432.
* **Hostname**: Specify the path to a master host or a {{ PG }} master host IP address. You can specify multiple hosts in a comma-separated list. If you are unable to connect to the first host, {{ datalens-short-name }} will select the next one from the list.
* **Port**: Specify the {{ PG }} connection port. In {{ datalens-short-name }}, the default port is 6432.
* **Path to database**: Specify the name of the database to connect to.
* **Username**: Specify the username for the PostgreSQL connection.
* **Username**: Specify the username for the {{ PG }} connection.
* **Password**: Enter the password for the user.
* **Cache TTL in seconds**: Specify the cache time-to-live or leave the default value. The recommended value is 300 seconds (5 minutes).
* **Raw SQL level**: Enables you to use an ad-hoc SQL query to [generate a dataset](../../concepts/dataset/settings.md#sql-request-in-datatset).
* **Raw SQL level**: Enables you to use an ad-hoc SQL query to [generate a dataset](../../datalens/concepts/dataset/settings.md#sql-request-in-datatset).
16 changes: 7 additions & 9 deletions en/_includes/datalens/datalens-db-connection-parameters.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
- **Hostname**. Specify the path to the master host or the ClickHouse master host IP address. You can specify multiple hosts in a comma-separated list. If you are unable to connect to the first host, DataLens will select the next one from the list.
- **HTTP interface port**. Specify the ClickHouse connection port. The default port is 8443.
- **Username**. Specify the username for the ClickHouse connection.
- **Hostname**: Specify the path to a master host or a {{ CH }} master host IP address. You can specify multiple hosts in a comma-separated list. If you are unable to connect to the first host, {{ datalens-short-name }} will select the next one from the list.
- **HTTP interface port**: Specify the {{ CH }} connection port. The default port is 8443.
- **Username**: Specify the username for the {{ CH }} connection.

{% include [datalens-db-note](datalens-db-note.md) %}

- **Password**. Enter the password for the user.
- **Cache TTL in seconds**. Specify the cache lifetime or leave the default value. The recommended value is 300 seconds (5 minutes).
- **Raw SQL level**. Enables you to use an ad-hoc SQL query to [generate a dataset](../../concepts/dataset/settings.md#sql-request-in-datatset).
- **HTTPS**. Enable the secure connection option if your server supports HTTPS.
{% include [datalens-db-note](datalens-db-note.md) %}

- **Password**: Enter the password for the user.
- **Cache TTL in seconds**: Specify the cache time-to-live or leave the default value. The recommended value is 300 seconds (5 minutes).
- **Raw SQL level**: Enables you to use an ad-hoc SQL query to [generate a dataset](../../datalens/concepts/dataset/settings.md#sql-request-in-datatset).
2 changes: 1 addition & 1 deletion en/_includes/datalens/datalens-db-note.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{% note warning %}

The user should have one of the following values set for the parameter [readonly](https://clickhouse.com/docs/en/operations/settings/permissions_for_queries/#settings_readonly):
The user should have one of the following values set for the parameter [readonly]({{ ch.docs }}/operations/settings/permissions_for_queries/#settings_readonly):

- `0`: All queries are allowed.
- `2`: Queries to read data and edit settings are allowed.
Expand Down
10 changes: 5 additions & 5 deletions en/_includes/datalens/datalens-limits.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@


_Limits_ are technical limitations due to DataLens architectural features. The limits cannot be changed.
_Limits_ are technical limitations due to {{ datalens-short-name }} architectural features. The limits cannot be changed.

#### General limits {#datalens-common-limits}

{% note info %}

DataLens has no limitation on the amount of data on the source you are connecting to.
{{ datalens-short-name }} has no limitation on the amount of data on the source you are connecting to.

{% endnote %}


| Type of limit | Value |
----- | -----
| ----- | ----- |
| Maximum number of tables in a single dataset | 32 |
| Maximum number of fields in a single dataset | 1200 |
| Maximum number of fields in a single dataset | 1,200 |


#### Chart data limits {#datalens-chart-data-limits}

Charts in DataLens can only display a limited amount of data. If the number of rows (columns and cells for pivot tables) in a dataset exceeds the established limit, the chart will not be built. Therefore, to build a chart from data in a large dataset, select a part of the data to display based on the limits below using [filters](../../concepts/dataset/settings.md#default-setting):
Charts in {{ datalens-short-name }} can only display a limited amount of data. If the number of rows (columns and cells for pivot tables) in a dataset exceeds the established limit, the chart will not be built. Therefore, to build a chart from data in a large dataset, select a part of the data to display based on the limits below using [filters](../../datalens/concepts/dataset/settings.md#default-setting):

| Chart type | Limit |
----- | -----
Expand Down
2 changes: 1 addition & 1 deletion en/_includes/datalens/datalens-sql-ch-example.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{% cut "Query example for a ClickHouse database" %}
{% cut "Query example for a {{ CH }} database" %}

```sql
SELECT Category, Month, ROUND(SUM(Sales))
Expand Down
17 changes: 11 additions & 6 deletions en/_includes/datalens/internal/datalens-yt-connection.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,27 @@
To create a CHYT connection:
To create a {{ ytsaurus-name }} CHYT connection:


1. Go to the [connections page](https://datalens.yandex.ru/connections).
1. Click **Create connection**.
1. Select **CHYT** as the connection type.
1. Select **{{ ytsaurus-name }} CHYT** as the connection type.


1. Specify the connection parameters:

* **YTsaurus token**: Manually set the OAuth token to use with YTsaurus. For more information, see the [YTsaurus documentation](https://ytsaurus.tech/docs/en/user-guide/storage/auth).
* **Hostname**: Specify the YTsaurus proxy server address.
* **{{ ytsaurus-name }} token**: Manually set the OAuth token to use with {{ ytsaurus-name }}. For more information, see the [{{ ytsaurus-name }} documentation](https://ytsaurus.tech/docs/en/user-guide/storage/auth).
* **Hostname**: Specify the {{ ytsaurus-name }} proxy server address.
* **Port**: Specify the CHYT connection port.
* **Clique**: Specify the alias of a running clique. By default, the `*ch_public` public clique is used.
* **Clique alias**: Specify the alias of a running clique. By default, the `*ch_public` public clique is used.
* **Cache TTL in seconds**: Specify the cache time-to-live or leave the default value. The recommended value is 300 seconds (5 minutes).
* **Raw SQL level**: Select the SQL query access level for the user.
* **HTTPS**: Enable the secure connection option if your server supports HTTPS.


1. Click **Create connection**.
1. Enter a name for the connection and click **Create**.

{% include [datalens-check-host](../../../_includes/datalens/operations/datalens-check-host.md) %}
{% include [datalens-check-host](../../../_includes/datalens/operations/datalens-check-host.md) %}

## Additional settings {#additional-settings}

{% include [datalens-db-connection-export-settings](../../../_includes/datalens/operations/datalens-db-connection-export-settings.md) %}
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
1. Open the dataset.
1. In the upper-right corner, click **![image](../../../_assets/plus-sign.svg) Add field**.


1. In the left-hand panel, click ![image](../../../_assets/datalens/datasets.svg) **Datasets** and select the dataset you need. If you do not have a dataset, [create one](../../../datalens/operations/dataset/create.md).
1. In the top-right corner, click **![image](../../../_assets/plus-sign.svg) Add field**.
1. Enter a name for the field.
1. Select **Formula** as the data source for the field.
1. Set the formula using [data source functions](../../../function-ref/all.md).
1. Click **Create**. The field appears in the dataset.

1. Set the formula using [data source functions](../../../datalens/function-ref/all.md).
1. Click **Create**. The field will appear in the dataset.
8 changes: 4 additions & 4 deletions en/_includes/datalens/operations/datalens-create-dataset.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@



1. Go to the DataLens home page.
1. Go to the {{ datalens-short-name }} home page.
1. Click **Create dataset**.



1. On the left side of the screen, click **![image](../../../_assets/plus-sign.svg) Add**.
1. Select a connection. If there are no connections in the list, [create one](../../../concepts/connection.md).
1. Select a connection. If there are no connections in the list, [create one](../../../datalens/concepts/connection.md).
1. Select tables to use as the data source for the dataset and click **Save** in the top-right corner.

{% note warning %}

* The maximum number of tables in a single dataset is 32.
* The maximum number of fields in a single dataset is 1200.
* The maximum number of fields in a single dataset is 1,200.

{% endnote %}

1. Enter the dataset name and click **Create**. The dataset appears in the list.
1. Enter the dataset name and click **Create**. The dataset will appear in the list.
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@




1. Go to the workbook page.
1. In the top-right corner, click **Create****Connection**.


1. Select the **ClickHouse** connection.


1. In the window that opens, specify the connection parameters:

* Host name: `rc1a-ckg8nrosr2lim5iz.{{ dns-zone }}`.
* HTTP interface port: `8443` (default).
* Username: `samples_ro`.
* Password: `MsgfcjEhJk`.

1. Enable **Allow subqueries in datasets and queries from charts**.
1. Check the connection and click **Create connection**.
1. Enter `Sample ClickHouse` as your connection name.
1. Click **Create**.

![create-connection](../../../_assets/datalens/sql-chart/create-sample-connection-os.png)



Wait for the connection to be saved.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
**Disable data export**: When this option is enabled, the export data button will be hidden in the charts based on this connection. However, you will still be able to copy chart data and take screenshots.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
You can limit data export from charts by enabling **Disable data export** under **Advanced connection settings**. With this option enabled, the export data button will be hidden in the charts based on this connection. However, you will still be able to copy chart data and take screenshots.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# {{ speechkit-name }} Recognition gRPC API reference
The {{ speechkit-name }} Speech To Text Service API allows application developers to use speech recognition technologies. <br>The service does not operate with resources. Actions are performed by making RPC calls. For more information about API architecture, see [API Concepts]({{ api-url-prefix }}/api-design-guide/).

See the interface definitions of the API on [GitHub](https://github.com/nebius/nebius-solutions-library-for-ai).

Service | Description
--- | ---
[Recognizer](./stt_service.md) | A set of methods for voice recognition.
Loading

0 comments on commit c3dd715

Please sign in to comment.