tarantool / tarantool/doc

Update the 'Tarantool - Rocks' page

Open
#4,370 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Product: Tarantool, modules
Since: 2.11.0/2.11.1/3.0
Root document: https://www.tarantool.io/en/download/rocks

Details

The Tarantool - Rocks page contains outdated information:

  • tarantoolctl is used to install external modules. It is necessary to replace it with tt.
  • Since 2.11.x, the checks and metrics modules are built-in.
  • Consider adding the following external modules:
    • crud
    • metrics-export-role
    • experimental.connpool
    • decimal
    • datetime
  • Remove the following deprecated/obsolete modules:
    • shard
    • connpool
    • tradeparser
    • ldecnumber
    • graphite
    • prometheus
    • tap (in favor of luatest)
    • document (last commit two years ago)
    • mrasender
    • icu-date(in favor of datetime)
  • Enterprise SDK can be used as a source of actual external rocks. In this case, the following rocks should be also removed:
    • authman
    • dump
    • zookeeper
    • mysql
    • pg
    • cbench
    • gperftools
    • modulekit
    • cron-parser
    • lrexlib
    • lua-term
    • LuLPeg
    • gis
    • moonwalker
    • mqtt
    • memcached
    • watchdog

If we list only modules supported by our team, we need to drop this phrase: Want your module listed here? Please drop us a line at [doc@tarantool.io](mailto:doc@tarantool.io).

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 with the root document at https://www.tarantool.io/en/download/rocks and review the current Tarantool - Rocks content against the requested built-in, external, deprecated, and Enterprise SDK module lists. Done means the page uses tt, reflects the requested module changes, and either removes or retains the invitation to submit modules consistently with the chosen scope.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.