Skip to content

Integrate tarantool.io/en/dev/core & internals #2635

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
Open
1 of 4 tasks
Tracked by #2051
, #3175
...
patiencedaur opened this issue Jan 27, 2022 · 2 comments
Open
1 of 4 tasks
Tracked by #2051
, #3175
...

Integrate tarantool.io/en/dev/core & internals #2635

patiencedaur opened this issue Jan 27, 2022 · 2 comments
Labels
restructure Related to the transfer of sections, text.

Comments

@patiencedaur
Copy link
Contributor

patiencedaur commented Jan 27, 2022 •
edited
Loading

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 — это какая-то сборная солянка, утратившая актуальность"
image
@patiencedaur patiencedaur changed the title [Tech Debt] Integrate docs.tarantool.dev [Tech debt] Integrate docs.tarantool.dev Jan 27, 2022
@patiencedaur patiencedaur mentioned this issue Jan 27, 2022
Closed
22 tasks
@patiencedaur patiencedaur changed the title [Tech debt] Integrate docs.tarantool.dev [Tech debt] Integrate docs.tarantool.dev & internals Feb 4, 2022
@patiencedaur
Copy link
Contributor Author

tarantool/tarantool-internals#3

@patiencedaur
Copy link
Contributor Author

tarantool/tarantool-internals#32

@patiencedaur patiencedaur changed the title [Tech debt] Integrate docs.tarantool.dev & internals [Tech debt] Integrate tarantool.io/en/dev/core & internals Oct 3, 2022
@patiencedaur patiencedaur changed the title [Tech debt] Integrate tarantool.io/en/dev/core & internals Integrate tarantool.io/en/dev/core & internals Oct 3, 2022
@patiencedaur patiencedaur added restructure Related to the transfer of sections, text. and removed epic labels Oct 3, 2022
@patiencedaur patiencedaur mentioned this issue Oct 3, 2022
Closed
9 tasks
p7nov added a commit to tarantool/tarantool-internals that referenced this issue Oct 20, 2022
@p7nov
doc: fix typo in fiber.rst
494c3e8 
Resolves tarantool/doc#2635
@p7nov p7nov mentioned this issue Oct 20, 2022
Merged
@TarantoolBot TarantoolBot removed the 2sp label Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
restructure Related to the transfer of sections, text.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@TarantoolBot @patiencedaur