OpenRefine / OpenRefine/openrefine.org
Linux Install Instructions Enhancement
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 161
- Forks
- 142
- Avg merge
- 6h 10m
- Merged PRs (30d)
- 9
Description
There is a lack of clear instructions on installing and running OpenRefine on Linux. The current documentation for Linux installation only state that the user should download the tar.gz file containing the file, tar xzf openrefine-linux-3.4.tar.gz
Proposed solution
At the very least, the current documentation for Linux installation should be amended, as the command tar xzf openrefine-linux-3.4.tar.gz is deprecated. Note that the naming format is different from the current convention: openrefine-linux3.4.tar.gz instead of openrefine-3.6.2-linux.tar.gz. A solution would be replacing that command suggestion with tar xzf openrefine-3.6.2-linux.tar.gz.
Additionally, I believe that OpenRefine's users would benefit from instructions on how to run the program from the command line. This could take the form of the following:
Use the
cdcommand to navigate to the directory housing OpenRefine
brendan@librarium:~$ cd Documents/openrefine-3.6.2/
brendan@librarium:~/Documents/openrefine-3.6.2$
Run OpenRefine by entering
./refine
brendan@librarium:~/Documents/openrefine-3.6.2$ ./refine
OpenRefine will start.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Linux installation documentation and compare its archive naming and extraction command with the current OpenRefine release convention. Verify the documented command-line launch steps on Linux. Done means the page contains accurate extraction and launch instructions for the current naming format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- linux, shell
- Domain
- documentation, operating-systems
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100