Document package search paths and ways to build complex applications
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
The only reference to a canonical way to develop modules for tarantool the current docs make is the module skeleton on github and the manual that comes with it.
Our users nowadays build complex applications and need guidance from us not only how to build modules, but also how to embed them in their applications, ship along, and upgrade in production.
@knazarov has had to develop a canonical way to build and ship lua appilcations in the enterprise, and we need to do the same for our community.
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
The issue names the module skeleton on GitHub and its accompanying manual as the current references; start by reviewing those materials and the existing documentation. Done should provide canonical guidance for Lua package search paths, building complex applications, embedding modules, shipping applications, and upgrading them in production.
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
- 25/100