zammad-documentation icon indicating copy to clipboard operation
zammad-documentation copied to clipboard

Rework or drop source installation instructions because it doesn't work (at least for the tested scenario)

Open ralf401 opened this issue 1 year ago • 5 comments

In case of reworking the instructions, at least the following points should be checked for Ubuntu Server 24.04:

  • Add command for adding user to rvm group
  • Investigate which command has to be executed as which user
  • Investigate if there is another possibility than add sudo group to user zammad.
  • Check why adding rails environment variables doesn't work from a different user than zammad (even with sudo)
  • TBD

ralf401 avatar Nov 25 '24 16:11 ralf401

@YetAnotherGerrit & @mgruner: I tried to install Zammad again from source and it doesn't work if you just follow the documentation. Even if you are using a plain Ubuntu... And we have 3/4 different distros to cover, this is barely maintainable. I recommend to think again about dropping the source installation instructions. If internally needed, we could move it to the knowledgebase, Gitlab or another appropriate place.

Feel free to disagree. But in my eyes the effort is high and the outcome is very small.

ralf401 avatar Nov 25 '24 16:11 ralf401

I agree that from source installation is something rarely used in production. But we need to make sure to not close the doors to open-source development enthusiasts. Maybe we can join it somehow with the "how to contribute" manual, so someone who wants to contribute as a developer can get a dev env up and running?

YetAnotherGerrit avatar Nov 26 '24 07:11 YetAnotherGerrit

But we need to make sure to not close the doors to open-source development enthusiasts. Maybe we can join it somehow with the "how to contribute" manual, so someone who wants to contribute as a developer can get a dev env up and running?

I don't think we are closing any doors by dropping it. There is a developer manual on Github where people can find detailed installation instructions (see How to set up a development environment). This development guide is even linked in the zammad repo README.md.

So my suggestion is to temporarily link to this Github developer manual from the source installation page and add it to the contribution section. After the next release we can remove the souce installation page from the documentation.

Any objections?

ralf401 avatar Nov 26 '24 10:11 ralf401

I talked with several stakeholders, no veto from my side. Thank you for taking care!

YetAnotherGerrit avatar Nov 27 '24 07:11 YetAnotherGerrit

Note: preserve an archive branch

ralf401 avatar Nov 27 '24 13:11 ralf401