Merge and revamp SQL tutorials
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
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.
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 comparing the two named pages: SQL beginner's guide and SQL tutorial. Identify repeated entry-level SQL material and Tarantool-specific content, then consolidate the relevant material into one end-to-end SQL-in-Tarantool tutorial. Done means the duplicate pages are merged or redirected and the resulting documentation has a clear scope for readers and maintainers.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- sql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100