Project

General

Profile

Actions

Task #4216

closed

Make Mentat executable from within the cloned Git repository

Added by Jan Mach about 4 years ago. Updated about 3 years ago.

Status:
Closed
Priority:
High
Assignee:
Category:
Documentation
Target version:
Start date:
07/27/2018
Due date:
% Done:

100%

Estimated time:
To be discussed:

Description

It would be very useful for future contributors if it was possible to develop and execute Mentat modules from within the cloned Git repository. Currently the development process is little bit awkward. Part of this task is also writing the manual for developer and contributors.

Actions #1

Updated by Jan Mach almost 4 years ago

  • Target version changed from Backlog to 2.2
Actions #2

Updated by Jan Mach almost 4 years ago

  • Target version changed from 2.2 to 2.3
Actions #3

Updated by Jan Mach over 3 years ago

  • Target version changed from 2.3 to 2.4
Actions #4

Updated by Jan Mach over 3 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 10
Actions #5

Updated by Jan Mach over 3 years ago

  • Status changed from In Progress to Closed
  • % Done changed from 10 to 100
Actions #6

Updated by Jan Mach over 3 years ago

  • Status changed from Closed to Feedback
  • Assignee changed from Jan Mach to Radko Krkoš
  • % Done changed from 100 to 90

Radko, could you please walk through these installation instructions and attempt to install working Mentat instance from Debian package and local Git repository to verify the installation instructions. I am striving to make the installation process as simple as possible and if you are not able to have working instance in half an hour this task should be improved further.

I would like another set of eyes to look through it, because after working on it I am biased.

Please install development version, necessary code changes are not yet merged to the master/production branch.
Actions #7

Updated by Jan Mach over 3 years ago

  • Priority changed from Normal to High
Actions #8

Updated by Radko Krkoš over 3 years ago

I have tested the instructions for manual installation.

Here are some other remarks:

  • What I am missing is a mention that the steps have to be run as root. Using sudo (in various places where required) will not result in a working installation as the environment is very different from what seems to be expected. (I have not tested this thoroughly, I might have been trying to install the stable version [2.3.2] at the time).
  • I advise to include the installation commands for postgresql and ip4r and the mention that the server must listen on port 5432. For a clean installation, it would be highly beneficial. We should not expect the Mentat admin to be a PostgreSQL admin also (or to read the documentation to a third-party extension).
  • The development documentation should probably reference the development repositories for mentat, not the stable ones (steps 2 and 3).
  • In step 9, the /etc/mentat/scripts/sqldb-migrate.sh stamp head command has to be run inside the venv, otherwise it fails with alembic: command not found

Unfortunately it took me quite a bit longer than the agreed limit of half and hour to get the mentat working.
I have not yet tried the git repository instructions.

Actions #9

Updated by Jan Mach over 3 years ago

Radko Krkoš wrote:

I have tested the instructions for manual installation.

Here are some other remarks:

  • What I am missing is a mention that the steps have to be run as root. Using sudo (in various places where required) will not result in a working installation as the environment is very different from what seems to be expected. (I have not tested this thoroughly, I might have been trying to install the stable version [2.3.2] at the time).

Done.

  • I advise to include the installation commands for postgresql and ip4r and the mention that the server must listen on port 5432. For a clean installation, it would be highly beneficial. We should not expect the Mentat admin to be a PostgreSQL admin also (or to read the documentation to a third-party extension).

Done, added section about installation of prerequisites.

  • The development documentation should probably reference the development repositories for mentat, not the stable ones (steps 2 and 3).

Sadly, this is not possible. To my knowledge and according to my research RST does not allow variable substitutions in code blocks.

  • In step 9, the /etc/mentat/scripts/sqldb-migrate.sh stamp head command has to be run inside the venv, otherwise it fails with alembic: command not found

Done.

Unfortunately it took me quite a bit longer than the agreed limit of half and hour to get the mentat working.
I have not yet tried the git repository instructions.

Actions #10

Updated by Jan Mach over 3 years ago

  • Assignee changed from Radko Krkoš to Pavel Kácha
  • % Done changed from 90 to 100

Pavel, during our conference you have volunteered to perform another test installation. Do you still have time to do it? If not, we can close the issue a polish the instructions later. I think, that all changes at this point should be purely cosmetic, as I have already tested the installation many times.

Actions #11

Updated by Jan Mach about 3 years ago

  • Status changed from Feedback to Closed

Ok, let`s close this issue, so we can close the whole version.

Actions

Also available in: Atom PDF