Skip to content

Merge and revamp SQL tutorials #3646

@p7nov

Description

@p7nov
Contributor

There are two SQL tutorials in Tarantool docs:

Issues:

  • they are both huge
  • they are repeating each other
  • there is no clear difference between them from the reader's point of view
  • the beginner's guide provides a lot of entry-level SQL content that is not a matter of Tarantool docs (for example, what is a table).

This leads to problems for both the doc team and the readers:

  • readers don't know what's the difference and which guide should they choose
  • the doc team wastes a lot of effort on supporting these pages when new SQL features come out or the behavior changes
  • it's a duplicating content that we (teamD, teamX, translators) have to maintain

Proposed solution: merge the two pages in a single end-to-end tutorial on using SQL in Tarantool, leaving only the relevant content.

Activity

changed the title [-]Revamp SQL tutorials[/-] [+]Merge and revamp SQL tutorials[/+] on Aug 29, 2023
andreyaksenov

andreyaksenov commented on Aug 29, 2023

@andreyaksenov
Contributor

It also might be useful to make examples more human-readable. For example, replace generic table2/t6/whatever names and corresponding values ([0, '!!!', "\0", null, 0, '!!!']) with smth more understandable (examples here look much clearer https://mariadb.com/kb/en/foreign-keys/).

UPD: Added several runnable samples with human-readable data, for example:

added
sql[location] SQL manual
tutorial[area] Related to Tutorials
restructureRelated to the transfer of sections, text.
on Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    restructureRelated to the transfer of sections, text.sql[location] SQL manualtutorial[area] Related to Tutorials

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @andreyaksenov@p7nov@veod32

        Issue actions

          Merge and revamp SQL tutorials · Issue #3646 · tarantool/doc