Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pdurbin opened this issue Jan 17, 2023 · 5 comments
Closed

Comments

@pdurbin
Copy link
Member

pdurbin commented Jan 17, 2023

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:

  • Database Persistence (the default works well enough, this could go under "advanced" perhaps)
  • BagIt File Handler
  • BagIt Export

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
Copy link
Contributor

poikilotherm commented Jan 18, 2023

A few thoughts:

  • Maybe it's time to move all configuration things into ONE configuration guide with subpages for the different topics?
  • Maybe we can adapt something like https://diataxis.fr to enhance our docs?
  • Maybe we should create custom roles for all of our settings on the different subpages, so we can have Sphinx generate an index of them for quick referencing?
  • Probably doing this with a 33 instead of a 10 is time well spent.

@kuhlaid
Copy link
Contributor

kuhlaid commented Jan 20, 2023

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
Copy link
Member Author

pdurbin commented Mar 22, 2024

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

@pdurbin
Copy link
Member Author

pdurbin commented Aug 21, 2024

@poikilotherm @kuhlaid thanks for your feedback.

I still want to simplify this list somehow but we can create a fresh issue when we're ready to work on it. Closing.

@pdurbin pdurbin closed this as completed Aug 21, 2024
@donsizemore
Copy link
Contributor

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.

@kuhlaid historically IQSS used NetBeans on Mac OS; most containerized solutions I've seen have used Ubuntu under the hood. Realistically Dataverse will run on any operating system which can run Java 17 and Postgres; whether services are launched by systemd or init.d or entrypoint scripts are dependent on the underlying platform.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants