Documentation: Document various temp directories used by Dataverse
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.1k
- Forks
- 564
- Avg merge
- 2d 2h
- Merged PRs (30d)
- 29
Description
Currently we use several temp directories for different purposes and while not usually an issue for end users, it may impact system admins as a maintenance issue.
Known temp directories:
/tmp
Used by ingest and Two Ravens. Two Ravens does not clean up after itself, ingest (mostly) does. Suggested to use a /tmp cleaner cron job but may be able to further clean up after self.
JSP
eg.
/usr/local/glassfish4/glassfish/domains/domain1/generated/jsp/dataverse-4.2.3
where dataverse-4.2.3 is the name of the deployed application
Used by the Prime Faces upload control until dataset is saved. Can oprhan files here if file uploads fail or session is abandoned, etc.
Suggested to link this to larger storage area and assign a cleaner cron job.
Others?
Contributor guide
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 listed /tmp and GlassFish JSP paths, then inspect the repository’s administrator-facing documentation to find the appropriate location for this inventory. Document each directory’s purpose, cleanup behavior, and maintenance recommendation, and check whether other temporary directories need to be included.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100