IQSS / IQSS/dataverse

Restructure Prep, Prerequisites, and Installation guides to distinguish between required dependencies and optional ones

Open
#9,535 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Feature: Installation Guide Type: Suggestion User Role: Sysadmin
Dominant language
Java
Stars
1.1k
Forks
564
Avg merge
2d 2h
Merged PRs (30d)
29

Description

What steps does it take to reproduce the issue?

The Dataverse Prep, Prerequisites, and Installation guides lists not needed prerequisites and also misses needed dependencies. Namely R, RServer, project COUNTER and ImageMagick are optional dependencies to enhance the functionality but are listed in the prerequisites section. Requirements for the dvinstaller (python,curl) are not listed there.

Documentation Page Prerequisites list ImageMagick, R/Rserve and Counter Processor as prerequisites. Within the descriptive text its mentioned that those are optional but it easy to miss that. Hence, I propose to move those sections to the Advanced Installation Optional Components.

Documentation Page Installation lists additional and assume other requirements to execute the dvinstaller. pqsql is mentioned but for example python3, and curl are just assumed to be available. It would be nice to state those requirements within the Prerequisites page.

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.

Research direction

Start with the Prep, Prerequisites, Advanced Installation, and Installation pages linked in the issue, especially their Required Components, Optional Components, and prerequisite sections. Verify which dependencies are required versus optional, including the dvinstaller requirements, then update the guides so the categories and requirements are explicit and consistent.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql, python, r
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.