Integrate tarantool.io/en/dev/core & internals
Open
Nobody has claimed this yet.
restructure
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Epic: Restructure Tarantool docs, stage 3
SME: @ kyukhin
Details
- Here is the documentation to Tarantool internals that are relevant mostly for Tarantool developers: https://github.com/tarantool/tarantool-internals.
- Here is other internals documentation useful for other developers (like connector developers): https://www.tarantool.io/en/doc/latest/dev_guide/internals/
- Make sure the readers can find both sources.
- Due to limited team capacities, there are currently no resources to create a unified search engine for /doc, /enterprise_doc, and /dev/core. Moreover, Sphinx has issues with external links in the menu.
- We can still help devs find the information by creating a workaround. We can write an introductory page for internals with all the keywords in /doc and provide links to /dev/core. This page will also link to the existing internals hosted at /doc.
Definition of done
- Add meaningful overview text to the Internals page, linking to all the important sections in /dev/core and /dev_guide/internals
- Redirect if needed
Related tasks (JFYI)
@ veod32 says:
"Как мне кажется, сейчас Internals — это какая-то сборная солянка, утратившая актуальность"

Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing Internals page and the linked tarantool-internals and /dev_guide/internals documentation to identify the important sections and current links. Check whether a redirect is needed, then update the Internals page with an overview linking to both sources. Done means readers can find the relevant internals information from that page.
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
- Mostly clear
- Newbie friendliness
- 35/100