IQSS / dataverse

Open source research data repository software
http://dataverse.org
Other
859 stars 482 forks source link

reduce number of steps before "going live" steps in Installation Guide #9295

Open pdurbin opened 1 year ago

pdurbin commented 1 year ago

I introduced the "Going Live" steps in the installation guide in 4.6.2: https://guides.dataverse.org/en/4.6.2/installation/config.html#going-live-launching-your-production-deployment

Here's how the guides looked back then

Screenshot 2023-01-17 at 13-46-08 Configuration — Dataverse org

Fast forward to today (including #8915 which isn't yet merged) and the list of steps before going live is quite long:

Screenshot 2023-01-17 at 13-45-55 Configuration — Dataverse org

I'm concerned that people installing Dataverse will be intimidated by this long list. We should reorganize the Installation Guide a bit (let's say timeboxed to size of 10 or a full day) to put non-essential config elsewhere.

Candidates to move elsewhere:

I'm also open to other ideas but I hope I've captured the problem: a very long list to grok.

Or as @poikilotherm put it in a talk:

meme-so-many

poikilotherm commented 1 year ago

A few thoughts:

kuhlaid commented 1 year ago

I would leave the install guide alone. Anyone looking at the prerequisites list will be intimidated regardless of anything else, much less getting to the 'going live' part. Speaking for myself, as someone who has yet to successfully install Dataverse, getting a containerized build script to handle the install would be ideal to simplify things and aid in adoption of the software. The fact that Dataverse seems to be exclusively developed using a non-containerized RedHat environment is a major barrier to 'simplifying' the install process.

I will revisit the Docker script I was working on with Windows 10 since I upgraded to Windows 11, which 'supposedly' has the systemd support needed in Windows Subsystem for Linux to possibly run the Dataverse from Docker scripts. Manually installing software requirements to manually setup a development environment seems like an ancient idea in our age of containers and virtualization.

pdurbin commented 3 months ago

Wow, the list is even longer now, especially with all the PID settings from PR #10234:

Screenshot 2024-03-22 at 11-31-27 Configuration — Dataverse org