[3pt] Update building from source

Open Beginner friendly
#2,469 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
65/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

build factual error

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-pyyaml module is no more in the apt-get repository and it has now been named python3-yaml. But this has not been updated in the instructions.

image

  • 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-pyyaml to python3-yaml
  • Add instructions to install python libraries using virtual environment of conda or venv or virtualenv
Dominant language
CSS
Stars
15
Forks
49
Avg merge
1d 13h
Merged PRs (30d)
3

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.

More from tarantool/doc

All issues in tarantool/doc

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.