tarantool / tarantool/doc

Add a table of module versions support

Open
#2,643 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

add details ecosystem vshard
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

Description

There is no info in the doc on what module versions are compatible. Map module versions to Tarantool versions (and to each other?).

Two options (ask users before choosing one):

  • Create a table on a separate page, cross-link from different modules.
  • Add a table for each module in the corresponding part of the doc.

VShard now supports only Tarantool >= 1.10.1
It used to support 1.9 too, but now it is dropped. To use VShard

0.1.19 a user needs Tarantool >= 1.10.1.
Requested by @Gerold103 in https://github.com/tarantool/vshard/commit/4027b571e5f7b9edbf9e153f127e2d1172cc2647.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing documentation sections for each module and the VShard compatibility note in the issue. Ask users to choose between a shared compatibility page and per-module tables, then document module-to-Tarantool version mappings and cross-links. Done means the supported versions, including VShard 0.1.19 and Tarantool 1.10.1, are clearly recorded.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.