Developer Guide¶

Contents:

Introduction
- Intended Audience
- Getting Help
- Core Technologies
- Roadmap
- Kanban Board
- Issue Tracker
- Related Guides
- Related Projects
Development Environment
- Quick Start
- Set Up Dependencies
- Run the Dataverse Installer Script
  - Verify Dataverse is Running
- Configure Your Development Environment for Publishing
- Next Steps
Windows Development
- Running Dataverse in Vagrant
- Improving Windows Support
  - Windows Subsystem for Linux
  - Discussion and Feedback
Tips
- Iterating on Code and Redeploying
- Netbeans Connector Chrome Extension
- Database Schema Exploration
  - pgAdmin
  - SchemaSpy
- Deploying With asadmin
- Running the Dataverse Installation Script in Non-Interactive Mode
- Preventing Payara from Phoning Home
- Solr
- Git
- Sample Data
- Switching from Glassfish to Payara
Troubleshooting
- context-root in glassfish-web.xml Munged by Netbeans
- Configuring / Troubleshooting Mail Host
- Rebuilding Your Dev Environment
- DataCite
Version Control
- Where to Find the Dataverse Code
- Branching Strategy
  - Goals
  - Branches
- How to Make a Pull Request
- How to Resolve Conflicts in Your Pull Request
- Adding Commits to a Pull Request from a Fork
SQL Upgrade Scripts
- Location of SQL Upgrade Scripts
- How to Determine if You Need to Create a SQL Upgrade Script
- How to Create a SQL Upgrade Script
- Troubleshooting
  - Renaming SQL Upgrade Scripts
Testing
- The Health of a Codebase
- Testing in Depth
- Unit Tests
  - Unit Test Automation Overview
  - Writing Unit Tests with JUnit
- Integration Tests
- Measuring Coverage of Integration Tests
- Load/Performance Testing
  - Locust
  - download-files.sh script
- Continuous Integration
  - Enhance build time by caching dependencies
  - The Phoenix Server
- Accessibility Testing
  - Accessibility Policy
  - Accessibility Tools
- Future Work
Writing Documentation
- Quick Fix
- Other Changes (Sphinx)
  - Installing Sphinx
  - Using Sphinx
- Table of Contents
- Images
  - GraphViz based images
- Versions
Dependency Management
- Terms
- Direct dependencies
- Transitive dependencies
  - Managing transitive dependencies in pom.xml
- Helpful tools
- Repositories
Debugging
- Logging
Coding Style
- Java
- Bash
  - Formatting Code
    - Tabs vs. Spaces
- Bike Shedding
Deployment
- Deploying Dataverse to Amazon Web Services (AWS)
Docker, Kubernetes, and Containers
Making Releases
- Create the release GitHub issue and branch
  - 1. Bump Version Numbers
  - 2. Check in the Changes Above...
- Merge “develop” into “master”
- Write Release Notes
- Make Artifacts Available for Download
- Publish Release
Tools
- Netbeans Connector Chrome Extension
- pgAdmin
- Maven
- Vagrant
- PlantUML
- Eclipse Memory Analyzer Tool (MAT)
- PageKite
- MSV
- FontCustom
- SonarQube
- Infer
- lsof
- jmap and jstat
Universal Numerical Fingerprint (UNF)
- UNF Version 3
- UNF Version 5
- UNF Version 6
Make Data Count
- Architecture
- Dev Environment Setup for Make Data Count
  - Generate Fake Metrics Only
  - Full Setup
- Testing Make Data Count and Dataverse
- Resources
Shibboleth and OAuth
- Shibboleth and OAuth
Geospatial Data
- Geoconnect
- How Dataverse Ingests Shapefiles
  - Ingest
  - Example
- WorldMap JoinTargets + API Endpoint
SELinux
- Introduction
- Development Environment
- Recreating the shibboleth.te File
Big Data Support
- S3 Direct Upload and Download
- Data Capture Module (DCM)
- Repository Storage Abstraction Layer (RSAL)
Workflows
- Introduction
  - Administration
  - Available Steps
    - log
    - pause
    - http/sr
    - archiver