IQSS / IQSS/dataverse

Typo Correction in "Information to Send to Support When Installation Fails" Section

Open
#9,610 6 comments 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

There is a typo in the "Information to Send to Support When Installation Fails" section of the documentation. The following sentence contains a typographical error:

"The scripts/api/setup-all.*.log files left behind by the installer."

The mention of "scripts/api/setup-all.*.log" is incorrect and can be misleading as this file does not exist.

I don't have a proposed solution to replace this mention. However, I suggest either removing this sentence or modifying it to provide an appropriate alternative.

This should be corrected to avoid any confusion and ensure the accuracy of the information provided to users.

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

Open the linked installation documentation at the “Information to Send to Support When Installation Fails” section and inspect the sentence mentioning scripts/api/setup-all.*.log. Verify the appropriate log reference or whether the sentence should be removed; the work is done when the documentation no longer points users to a nonexistent file.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.