Clarify the term "modules"
Open
Nobody has claimed this yet.
design
ecosystem
raw idea
server
terminology
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Epic: Restructuring Tarantool docs
Details
@ NeraverinTarantool's viewpoint
The term "module" has many different meanings:
- a Lua library that simplifies writing Lua code
- an application like Cartridge CLI
- a framework like vshard or Cartridge that influences the whole architecture
Besides, modules have different installation methods:
- a built-in module
- an external Lua rock
- a community module
- a standard Lua rock
@ kyukhin's viewpoint
- Cartridge CLI, just like tarantoolctl, is not a module but an application and should be called so
- Modules can be classified in several ways:
- public/closed-source
- standard Lua rocks/created by the Tarantool team/community modules
- built-in/external
- Large entities like vshard and cartridge might need to be called something other than "modules".
TBD
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 “Restructuring Tarantool docs” epic and review how the documentation currently uses “module,” including references to Lua libraries, applications, frameworks, and Lua rocks. Agree on terminology and classification before editing; done means the documentation consistently distinguishes these entities and installation types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- lua
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100