[3pt] Update building from source
Open
Beginner friendly
Nobody has claimed this yet.
build
factual error
- Dominant language
- CSS
- Stars
- 15
- Forks
- 49
- Avg merge
- 1d 13h
- Merged PRs (30d)
- 3
Description
Update "Building From Source"
Product: Tarantool
Root document: https://www.tarantool.io/en/doc/latest/dev_guide/building_from_source/
Details
- I was building Tarantool locally using the instructions in https://www.tarantool.io/en/doc/latest/dev_guide/building_from_source/. There seems to be an issue in the instructions provided for building in the Ubuntu/Debian.
- the
python3-pyyamlmodule is no more in the apt-get repository and it has now been namedpython3-yaml. But this has not been updated in the instructions.

- Ref: Line 1 of the instructions
- Also it will be good if for the development purpose the python modules are installed using a virtual environment created using conda, venv or virtualenv, rather than installing the modules the system python. So adding instructions regarding the same will be helpful.
Definition of done
- update
python3-pyyamltopython3-yaml - Add instructions to install python libraries using virtual environment of conda or venv or virtualenv
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 root document at https://www.tarantool.io/en/doc/latest/dev_guide/building_from_source/. Check the Ubuntu/Debian build instructions, update python3-pyyaml to python3-yaml, and add guidance for installing Python libraries in a conda, venv, or virtualenv environment. Done means both checklist items are addressed in the published instructions.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 65/100