TDB (iproto): create and update the `User's Guide` section #4067

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

Closed

4 tasks done

Tracked by

xuniq opened this issue Feb 28, 2024 · 1 comment

Closed

4 tasks done

Tracked by

TDB (iproto): create and update the `User's Guide` section #4067

xuniq opened this issue Feb 28, 2024 · 1 comment

Assignees

Labels

Contributor

xuniq commented Feb 28, 2024 •

edited

Loading

Epic: #4002
Product: Tarantool DB
Root document:

to be created: https://github.com/tarantool/tarantooldb/blob/master/doc/user_guide/

SME: @ a1div0 @ Galiev-Ruslan

Details

Guide structure

Quickstart (запуск через Docker)
Эволюция схемы данных (миграции)
Выполнение миграций с удаленной машины
Read view
Использование модуля устаревания данных expirationd
Troubleshooting (кейсы для юзера)
- Модуль оценки производительности (Tracing)
- Модуль логирования долгих запросов slow_log

Definition of done

proofread the section: language, style, formatting
reduce the number of cross-links, add and update other links if needed
add intro description to the User's Guide page
add overview texts to other pages if needed

xuniq added the TDB label

xuniq changed the title ~~TDB (iproto): Create User's Guide~~ TDB (iproto): create User's Guide

xuniq self-assigned this

xuniq changed the title ~~TDB (iproto): create User's Guide~~ TDB (iproto): create the User's Guide section

xuniq added the rewrite label

xuniq mentioned this issue

[Epic] TDB(iproto) documentation Q1, релиз 1.0 #4002

Closed

9 tasks

xuniq changed the title ~~TDB (iproto): create the User's Guide section~~ TDB (iproto): create and update the User's Guide section

Contributor Author

xuniq commented Apr 3, 2024

Merged in scope of https://github.com/tarantool/tarantooldb/pull/304

xuniq closed this as completed

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