-
Notifications
You must be signed in to change notification settings - Fork 43
Open
Labels
restructureRelated to the transfer of sections, text.Related to the transfer of sections, text.sql[location] SQL manual[location] SQL manualtutorial[area] Related to Tutorials[area] Related to Tutorials
Description
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.
Metadata
Metadata
Assignees
Labels
restructureRelated to the transfer of sections, text.Related to the transfer of sections, text.sql[location] SQL manual[location] SQL manualtutorial[area] Related to Tutorials[area] Related to Tutorials
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
[-]Revamp SQL tutorials[/-][+]Merge and revamp SQL tutorials[/+]andreyaksenov commentedon Aug 29, 2023
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:
test/sql
folder.