tarantool / tarantool/doc

[Epic] TDB (IPROTO): rework Docker examples

Open
#5,128 0 comments 0 reactions 1 assignee View on GitHub

@xuniq is already working on this.

Since May 23, 2025.

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

Description

Product: TDB
Root document: https://www.tarantool.io/en/tarantooldb/doc/latest/
Confluence: https://confluence.vk.team/pages/viewpage.action?pageId=1667911624
SME: @ a1div0 @ veod32 @ Galiev-Ruslan

Details

Currently, the documentation contains a lot of preconfigured examples (migrations, dictionary, expirationd, etc.) that could be run and tested using Docker.
All examples are stored in TDB repo in the doc/examples directory.

We need to think of some other solution(s) instead of Docker - for both product and fstek documentation. Maybe manual deploy with tt CLI?

To-do:

  1. discuss possible solutions for these examples, estimate the cost for TDB and Doc Teams
  2. rework the code of these examples (TDB Team)
  3. update the corresponding chapters in product docs (Doc Team)
  4. prepare drafts with the reworked examples in fstek docs (in advance) (Doc Team)

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.