Developer On-boarding


1 Introduction to ArchivesSpace
1.1 Relevant Links
1.1.1 General
1.1.2 Documentation
1.1.3 GitHub Repositories
1.1.4 You Tube Channels
1.1.5 Public Servers
1.2 Code of Conduct
2 Software Development Process
2.1 JIRA tickets and GitHub issues
2.1.1 Information to include in tickets
2.1.2 Development Prioritization
2.2 Code management
2.3 GitHub Process
2.3.1 Introduction to Git
2.3.2 Core Committers
2.5 Standups and Sprints
2.6 Releases
3 Code Base
Languages, platforms, and included open source projects
3.1.1 Languages
3.1.2 Platforms
3.1.3 Additional open source projects
3.2 Directory Structure
3.2.1 _yard
3.2.2 backend
3.2.3 build
3.2.4 clustering
3.2.5 common
3.2.6 contribution_files
3.2.7 docs
3.2.8 frontend
3.2.9 indexer
3.2.10 jmeter
3.2.11 launcher
3.2.12 oai
3.2.13 plugins
3.2.14 proxy
3.2.15 public
3.2.16 reports
3.2.17 scripts
3.2.18 selenium
3.2.19 solr
3.2.20 stylesheets
3.2.21 supervisord
3.3 Installation
3.4 Running the code
3.4.1 build.xml
3.4.2 Development Servers
3.4.3 Creating a Release
3.5 Databases
3.5.1 Apache Derby
3.5.2 MySQL
3.6 Scripts
3.7 Configuration File
3.8 Logging
3.9 Plugins
3.10 Deployment and Sys Admin
3.11 Apache Solr
3.12 Troubleshooting Hints
4 Developer Resources
4.1 Ruby tutorial
4.2 Rails Guides
4.3 Sinatra resources
4.4 Testing using RSpec
4.5 Solr – indexing platform – ArchivesSpace is on a very outdated version – 4.10.1
4.6 Place for exercises
5 First Ticket/Issue
6 Setting up a local environment
7 Writing code
8 How to run the test suite
9 How to submit code for review
10 Pull Requests
11 Frequently Asked Questions
Appendices
A. Build Targets