Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add Node.js topic documentation #10268

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

add Node.js topic documentation #10268

wants to merge 7 commits into from

Conversation

Zork33
Copy link
Contributor

@Zork33 Zork33 commented Oct 10, 2024 •
edited by blinkov
Loading

Changelog entry

Node.js topics documentation has been added. Initial version. Only in Russian for now

Changelog category

  • Documentation

Additional information

...

@Zork33 Zork33 requested a review from a team as a code owner October 10, 2024 01:08
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 10, 2024 •
edited
Loading

⚪ 2024-10-10 01:10:24 UTC Pre-commit check linux-x86_64-relwithdebinfo for fe854ca has started.
⚪ 2024-10-10 01:11:15 UTC Artifacts will be uploaded here
⚪ 2024-10-10 01:13:57 UTC ya make is running...
🔴 2024-10-10 01:14:31 UTC Build failed, see the logs.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 10, 2024 •
edited
Loading

⚪ 2024-10-10 01:12:12 UTC Pre-commit check linux-x86_64-release-asan for fe854ca has started.
⚪ 2024-10-10 01:12:55 UTC Artifacts will be uploaded here
⚪ 2024-10-10 01:15:47 UTC ya make is running...
🔴 2024-10-10 01:16:18 UTC Build failed, see the logs.

@github-actions GitHub Actions
Copy link

❌ Documentation build

Revision build failed

Build logs

Errors (5)

❌ /ru/reference/ydb-sdk/topic.md: 126: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

❌ /ru/reference/ydb-sdk/topic.md: 1334: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

❌ /ru/reference/ydb-sdk/topic.md: 1359: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

❌ /ru/reference/ydb-sdk/topic.md: 299: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

❌ /ru/reference/ydb-sdk/topic.md: 537: MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 10, 2024 •
edited
Loading

⚪ 2024-10-10 01:20:43 UTC Pre-commit check linux-x86_64-relwithdebinfo for f1703dd has started.
⚪ 2024-10-10 01:20:53 UTC Artifacts will be uploaded here
⚪ 2024-10-10 01:23:16 UTC ya make is running...
🟢 2024-10-10 01:24:39 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-10 01:24:46 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 10, 2024 •
edited
Loading

⚪ 2024-10-10 01:20:58 UTC Pre-commit check linux-x86_64-release-asan for f1703dd has started.
⚪ 2024-10-10 01:21:07 UTC Artifacts will be uploaded here
⚪ 2024-10-10 01:23:29 UTC ya make is running...
🟢 2024-10-10 01:24:51 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-10 01:24:56 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 10, 2024 •
edited
Loading

⚪ 2024-10-10 01:51:04 UTC Pre-commit check linux-x86_64-release-asan for 3eb28b6 has started.
⚪ 2024-10-10 01:51:16 UTC Artifacts will be uploaded here
⚪ 2024-10-10 01:53:45 UTC ya make is running...
🟢 2024-10-10 01:55:09 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-10 01:55:14 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 10, 2024 •
edited
Loading

⚪ 2024-10-10 01:53:14 UTC Pre-commit check linux-x86_64-relwithdebinfo for 3eb28b6 has started.
⚪ 2024-10-10 01:53:25 UTC Artifacts will be uploaded here
⚪ 2024-10-10 01:55:50 UTC ya make is running...
🟢 2024-10-10 01:55:56 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-10 01:56:02 UTC Build successful.

@github-actions github-actions bot added documentation Improvements or additions to documentation and removed new-feature labels Oct 11, 2024
blinkov
blinkov requested changes Oct 11, 2024
View reviewed changes
ydb/docs/ru/core/reference/ydb-sdk/topic.md Show resolved Hide resolved
ydb/docs/ru/core/reference/ydb-sdk/topic.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/reference/ydb-sdk/topic.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/reference/ydb-sdk/topic.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/reference/ydb-sdk/topic.md Outdated
Comment on lines 121 to 122
В этом примере используется вспомогательный метод `getCredentialsFromEnv()`, получающий токен из переменных окружения.
Например, `YDB_ACCESS_TOKEN_CREDENTIALS`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Не понятно что за «например» — как-будто имя переменных никак не настраивается. Надо более конкретно написать что откуда он берёт.

ydb/docs/ru/core/reference/ydb-sdk/topic.md Outdated Show resolved Hide resolved
ydb/docs/ru/core/reference/ydb-sdk/topic.md
Для создания читателя надо указать, из каких топиков (`topicsReadSettings`), и название консьюмера (`topicsReadSettings`), которое
должно быть указано при создании топиков.

А так же максимальный размер сообщений которые могут одновременно находится в очереди на обработку на клиенте (`receiveBufferSizeInBytes`).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

слишком много всего надо указывать, видимо нужно список из этого сделать

ydb/docs/ru/core/reference/ydb-sdk/topic.md
@@ -1208,6 +1425,22 @@
.build();
```

- Node.js

Полный список параметров смотри [в коде SDK](https://github-link.vercel.app/api?ghUrl=https://github.com/ydb-platform/ydb-nodejs-sdk/blob/main/src/topic/topic-client.ts&q=type%20ICreateReaderArgs).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

вводных слов не хватает

ydb/docs/ru/core/reference/ydb-sdk/topic.md
@@ -1242,6 +1475,17 @@

SDK получает данные с сервера партиями и буферизирует их. В зависимости от задач клиентский код может читать сообщения из буфера по одному или пакетами.

- Node.js

SDK получает данные с сервера партиями и буферизирует их. В зависимости от задач клиентский код может читать сообщения из буфера по одному или пакетами.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

копипаста не самой удачной фразы из соседнего SDK — терминологически запутанно выглядит

ydb/docs/ru/core/reference/ydb-sdk/topic.md
@@ -1292,6 +1536,17 @@

В асинхронном клиенте нет возможности читать сообщения по одному.

- Node.js

Чтобы читать сообщения без подтверждения обработки, по одному, используйте следующий код:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Чтобы читать сообщения без подтверждения обработки, по одному, используйте следующий код:
Чтобы читать сообщения без подтверждения обработки, по одному, используйте следующий код:

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 15, 2024 •
edited
Loading

⚪ 2024-10-15 13:49:14 UTC Pre-commit check linux-x86_64-release-asan for a45df8d has started.
⚪ 2024-10-15 13:49:25 UTC Artifacts will be uploaded here
⚪ 2024-10-15 13:51:49 UTC ya make is running...
🟢 2024-10-15 13:53:11 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-15 13:53:17 UTC Build successful.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 15, 2024 •
edited
Loading

⚪ 2024-10-15 13:50:12 UTC Pre-commit check linux-x86_64-relwithdebinfo for a45df8d has started.
⚪ 2024-10-15 13:50:22 UTC Artifacts will be uploaded here
⚪ 2024-10-15 13:52:46 UTC ya make is running...
🟢 2024-10-15 13:53:50 UTC Tests successful.

Test history | Ya make output | Test bloat

TESTS PASSED ERRORS FAILED SKIPPED MUTED?
0 0 0 0 0 0

🟢 2024-10-15 13:53:56 UTC Build successful.

@github-actions GitHub Actions
Copy link

✅ Documentation build

Revision built successfully
Revision preview link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@blinkov blinkov blinkov requested changes

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Zork33 @blinkov