Closed
Description
Description
This is a flat list of tasks related to restructuring docs. The tasks have been collected since 2021.
A 6-stage restructuring plan has been proposed (internal Notion document).
By October 2022, the two first stages of the plan have been implemented: #3054, #3116
Issues
- Integrate tarantool.io/en/dev/core & internals #2635
- Add the umbrella section Concepts #2987
- Clarify the term "modules" #2757
- Deprecate 1.6 and its doc #2663
- [0pt] Name for Cartridge docs in the TOC #1996
- Sort information about connectors #2667
- https://github.com/tarantool/tarantool.io/issues/1275
- Add supported architecture description #2487
- ☂️ Renew Tarantool Core developer guidelines (aka Contribution Guide) #1655
- Sort modules by purpose in the reference #2731
- Improve the Release Notes section #2734
- Move few pages of contribution guide to public Tarantool's wiki #2748
- Add page with list of documentation links for Tarantool modules #3148
Issues regarding individual topics
- Improve the Transactions section #2812
- Placement of Yields and Cooperative multitasking #2944
- Make the Getting Started section more intuitive #2805
- [2pt] Add example about working with varbinary fields #1542 - might require restructuring Indexes
- [13pt] Cartridge: restructure info about app start parameters and instances.yml #1651
- Determine cookbook location #1344
- module api: new region, ibuf, key_def, tuple, Lua/C APIs #1611
- Outdated and duplicate information in memtx section #2996
- [2pt] Describe LuaJIT profiler (aka "jit.p") #1986
Archive and brainstorming
NickVolynkin's idea
Понятное оглавление и навигация
Раздел про основы Тарантула: модель данных, основные понятия
Раздел про коннекторы (драйверы)
Раздел про разработку на Lua
Раздел про кластеризацию
Раздел про администрирование
NeraverinTarantool's idea
https://docs.google.com/document/d/16SQYAXRaL6H6EEnGXozJevXyVRKDk3QLndLfQrLjaho/edit