Skip to content

Move pages from Reference #3180

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.

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

Closed
10 tasks
Tracked by #3175
patiencedaur opened this issue Oct 4, 2022 · 1 comment
Closed
10 tasks
Tracked by #3175

Move pages from Reference #3180

patiencedaur opened this issue Oct 4, 2022 · 1 comment

Comments

@patiencedaur
Copy link
Contributor

patiencedaur commented Oct 4, 2022

Epic: Restructure Tarantool docs, stage 3

Related issue: #3179. Do them in a single PR.

Details

  • Move from Reference to Dev guide: Internals > Binary protocol (related: iproto: Incorrect document structure and ToC #2526 -- "Binary protocol" rewrite), MessagePack extensions, File formats, Replication internals
  • Move from Reference > Internals to How-to guides: "The recovery process"
  • Move from Reference to Dev guide: Limitations
  • Move from Reference to Dev guide: Tips on Lua syntax (rename to Tarantool Lua syntax because this is not a style guide)
  • Move translations
  • Fix links that broke after the changes
  • Provide cross-links to moved documents in relevant places
  • On the top-level page, add introductory text about developing with Tarantool. Add a link to the Tooling section
  • Add a page with a list of useful links: Awesome Tarantool, LuaJIT docs (SME: @ igormunkin), best practices and other links as listed below (SME: probably @ Totktonada). Here is a Notion document with some clues.
  • Add redirects after merge (instruction)

Desired structure of the Developer's Guide

Menu item order is TBD.

  • Tarantool Lua syntax
  • CRUD operations
  • Triggers
  • Internals (provide external link to tarantool.io/en/dev/core)
  • Developing with Cartridge (temporarily link to Cluster on Cartridge)
  • Links (one page, below are the contents)
    • Awesome Tarantool
    • Tutorials
    • Best practices
    • Reference
@andreyaksenov
Copy link
Contributor

The Developing applications section is going to be reworked: #3920.
See also: #3817.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants