Developer Guide

Contents:

• Introduction
  • Intended Audience
  • Getting Help
  • Core Technologies
  • Roadmap
  • Kanban Board
  • Issue Tracker
  • Related Guides
  • Related Projects
• Development Environment
  • Quickstart
  • Detailed Steps
  • Next Steps
  • Getting Help
• Windows Development
  • Running Dataverse in Windows WSL
• Tips
  • Iterating on Code and Redeploying
  • Netbeans Connector Chrome Extension
  • Thumbnails
  • Database Schema Exploration
  • Deploying With asadmin
  • Running the Dataverse Software Installation Script in Non-Interactive Mode
  • Preventing Payara from Phoning Home
  • Solr
  • Git
  • Sample Data
  • Switching from Glassfish to Payara
  • UI Pages Development
• 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 Software Code
  • Branching Strategy
  • How to Make a Pull Request
  • How to Resolve Conflicts in Your Pull Request
  • Adding Commits to a Pull Request from a Fork
  • Handing a Pull Request from a “develop” Branch
• 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
• Testing
  • The Health of a Codebase
  • Testing in Depth
  • Unit Tests
  • Integration Tests
  • Measuring Coverage of API Tests
  • Load/Performance Testing
  • Continuous Integration
  • Accessibility Testing
  • Future Work
• API Design
  • OpenAPI
  • Paths
• Security
  • Intake of Security Issues
  • Sending Security Notices
• Performance
  • Problem Statement
  • Current Practices
  • Abandoned Tools and Practices
  • Areas of Particular Concern
  • Suggested Practices
  • Conclusion
• Dependency Management
  • Introduction
  • Terms
  • Direct dependencies
  • Transitive dependencies
  • Helpful tools
  • Repositories
  • Dataverse Parent POM
• Debugging
  • Logging
  • Java Server Faces (JSF) Configuration Options
• Coding Style
  • Java
  • Bash
  • Bike Shedding
• Consuming Configuration
  • Simple Configuration Options
  • Complex Configuration Options
  • Why should I care about MicroProfile Config API?
  • Adopting MicroProfile Config API
• Deployment
  • Deploying the Dataverse Software to Amazon Web Services (AWS)
• Docker, Kubernetes, and Containers
  • Container Guide
  • Help Containerize Dataverse
  • Community-Lead Projects
  • Using Containers for Reproducible Research
• Making Releases
  • Introduction
  • Regular or Hotfix?
  • Ensure Issues Have Been Created
  • Declare a Code Freeze
  • Conduct Performance Testing
  • Conduct Regression Testing
  • Write Release Notes
  • Deploy Release Candidate to Internal
  • Deploy Release Candidate to Demo
  • Merge Release Notes (Once Ready)
  • Prepare Release Branch
  • Merge “develop” into “master” (non-hotfix only)
  • Add Milestone to Pull Requests and Issues
  • (Optional) Test Docker Images
  • Build the Guides for the Release
  • Create a Draft Release on GitHub
  • Run a Build to Create the War File
  • Build Installer (dvinstall.zip)
  • Make Artifacts Available for Download
  • Publish the Release
  • Update Guides Link
  • Close Milestone on GitHub and Create a New One
  • Update the Container Base Image Version Property
  • Deploy Final Release on Demo
  • Update SchemaSpy
  • Alert Translators About the New Release
  • Add the Release to the Dataverse Roadmap
  • Announce the Release on the Dataverse Blog
  • Announce the Release on the Mailing List
  • Announce the Release on Zulip
  • For Hotfixes, Merge Hotfix Branch into “develop”
  • For Hotfixes, Tell Developers to Merge “develop” into Their Branches and Rename SQL Scripts
  • Lift the Code Freeze and Encourage Developers to Update Their Branches
• Making Library Releases
  • Introduction
  • Maven Central (Java)
  • npm (JavaScript/TypeScript)
• Metadata Export Formats
  • Introduction
  • Exporter Basics
  • Building an Exporter
  • Specifying a Prerequisite Export
• Tools
  • Tools for Faster Deployment
  • Netbeans Connector Chrome Extension
  • pgAdmin
  • Maven
  • PlantUML
  • Eclipse Memory Analyzer Tool (MAT)
  • PageKite
  • MSV
  • FontCustom
  • SonarQube
  • Infer
  • lsof
  • JProfiler
  • 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
  • Testing Make Data Count and Your Dataverse Installation
  • Processing Archived Logs
  • Resources
• Shibboleth, OAuth and OIDC
  • Shibboleth and OAuth
  • OpenID Connect (OIDC)
• Geospatial Data
  • How The Dataverse Software Ingests Shapefiles
• SELinux
  • Introduction
  • Development Environment
  • Recreating the shibboleth.te File
• Big Data Support
  • S3 Direct Upload and Download
  • Trusted Remote Storage with the remote Store Type
  • Globus File Transfer
• Auxiliary File Support
  • Adding an Auxiliary File to a Datafile
  • Downloading an Auxiliary File that Belongs to a Datafile
  • Listing Auxiliary Files for a Datafile by Origin
  • Deleting an Auxiliary File that Belongs to a Datafile
• Direct DataFile Upload/Replace API
  • Overview
  • Requesting Direct Upload of a DataFile
  • Upload Files to S3
  • Adding the Uploaded File to the Dataset
  • To Add Multiple Uploaded Files to the Dataset
  • Replacing an Existing File in the Dataset
  • Replacing Multiple Existing Files in the Dataset
• Globus Transfer API
  • Requesting Upload or Download Parameters
  • Performing an Upload/Transfer In
  • Adding Files to the Dataset
  • Downloading/Transfer Out Via Globus
• Dataset Semantic Metadata API
  • Get Dataset Metadata
  • Add Dataset Metadata
  • Delete Dataset Metadata
  • Create a Dataset
  • Create a Dataset with a Dataset Type
• Dataset Migration API
  • Start Migrating a Dataset into a Dataverse Collection
  • Publish a Migrated Dataset
• Workflows
  • Introduction
• Font Custom
  • Previewing Icons
  • Install Font Custom
  • Updating Icons
  • Caveats About Font Custom
• Classic Dev Environment
  • Quick Start (Docker)
  • Classic Dev Environment
  • Set Up Dependencies
  • Run the Dataverse Software Installer Script
  • Configure Your Development Environment for Publishing
  • Configure Your Development Environment for GUI Edits
  • Next Steps
• Search Services
  • Design Overview
  • Key Components
  • Available Search Services
  • Notes

«Previous Next»