tarantool / tarantool/doc

☂️ [Tech debt] TDG2

Open
#2,649 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

epic
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

An umbrella epic for topisc and priorities on TDG2 documentation.

The developers collected customer FAQ: https://github.com/tarantool/beta-team-sandbox/wiki/tdg-faq (internal, provided by @ vrogach2020).

Priorities

Часть работы сводится к адаптации руководств по TDG 1.6 к версии 2.0.

config.yaml

@ tupikinm: первое, с чем сталкивается клиент — это config.yaml. описать параметры

Модель и типы данных

формат Date: https://github.com/tarantool/tdg2/blob/3a1ff76c73120331d8bd65412213b881bcf37551/common/utils.lua#L320

формат Datetime: https://github.com/tarantool/tdg2/blob/3a1ff76c73120331d8bd65412213b881bcf37551/common/utils.lua#L285

Запросы

  • TBD Решить, нужно ли делать отдельный документ "Руководство по интеграции" как было в док-ции 1.6 (https://www.tarantool.io/ru/tdg/1.6/requests/) — про разного вида запросы к данным

Коннекторы

Сервис-функции

Мониторинг

Алертинг (срочные уведомления)

Architecture & Introduction


Дизайн кластера: рекомендации как строить, какие роли

Разграничение прав доступа, авторизация

Другие задачи

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the TDG2 FAQ and the remaining unchecked linked issues, especially the config.yaml, authorization, and other tasks listed in this epic. Compare the TDG 1.6 documentation where referenced and inspect the linked TDG2 Date and Datetime definitions. Done means the outstanding documentation scope is resolved and the decision about a separate integration guide is recorded.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.