tarantool / tarantool/doc

Refactor getting started section

Open
#3,442 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Product: Tarantool, Cartridge
Since: latest
Audience/target: новички в клиентах, из open-source и наши новые сотрудники
Root document: getting started
SME: @artur-barsegyan

Details

  • В тутор в конец добавить еще примеры сценариев что можно делать на тарантуле. Сейчас там ссылки на github репозитории и это не дружелюбно по отношению к новому пользователю.

    Можно текстом описать основные кейсы.

    • Например, сказать что можно делать все тоже самое, что и в Redis. Отметить, что базовые вещи делаются сложнее, но при этом Tarantool мощный инструмент и на нем потом можно гибко решать задачи
    • Сказать, что в репозитории examples есть продвинутые кейсы. Рассказать о них подробнее и проверить по README, что они еще работают
  • "оч сумбурный тутор". В туториале не хватает больше технических деталей о том, как и почему это работает так. Разработчику может хотеться знать это

  • "Про файберы можно сказать, что они как в питоне"

  • "После туториала тарантула перешли к каржу и там сказано: мы можем все напрогать тут. Но не ясно: откуда берется возможность мочь все". Думаю, тут стоит рассказать чуть больше об app-server, найти картинку с архитектурой Tarantool и Cartridge. Показать, где и как исполняется код.

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 with the getting started root document and inspect the examples repository READMEs to identify working advanced cases. Map the tutorial's existing explanations of fibers, app-server, and Cartridge, then use the requested architecture material to add beginner-friendly scenarios and technical context. Done means the tutorial explains practical use cases, execution flow, and verified examples without relying only on GitHub links.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.