Document tuple compression API
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Related doc. issue(s): https://github.com/tarantool/enterprise_doc/issues/136
Product: Tarantool
Since: 2.10
Root document:
Details
Document compression options in the functions reference. Mention that it only works with Tarantool Enterprise and consider providing the link: https://www.tarantool.io/en/doc/latest/platform/ddl_dml/tuple_compression/
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 with the linked space_object:format(), space_object:create_index(), and space_object:alter() reference pages, and review the related enterprise documentation issue. Document the tuple compression options, note that they require Tarantool Enterprise, and link to the tuple compression guide; done means all three function references cover the API consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100