DIMS User Manual v 0.2.1

This is the DIMS User Manual (version 0.2.1).

• 1. Introduction
  • 1.1. Introduction
• 2. Referenced documents
• 3. Development and Core Tool Policy
  • 3.1. General Software Development Philosophy
  • 3.2. Source Code Control
  • 3.3. Copyright
  • 3.4. License
  • 3.5. Developing on a fork from GitHub
  • 3.6. Developing
• 4. Source Code Management with Git
  • 4.1. Foundational Git Resources
  • 4.2. The need for policy and discipline
  • 4.3. Global Git Configuration
  • 4.4. Daily tasks with Git
  • 4.5. Infrequent tasks with Git
• 5. Documenting DIMS Components
  • 5.1. Required Background Reading
  • 5.2. Why Sphinx?
  • 5.3. Manually Initiating a docs directory with sphinx-quickstart
  • 5.4. Building Sphinx Documentation
  • 5.5. Fixing errors
  • 5.6. Common Tasks
  • 5.7. Common Problems
  • 5.8. Advanced Use of Sphinx Features
• 6. Continuous Integration
  • 6.1. Continuous Integration
  • 6.2. How source changes are propagated
  • 6.3. Continuous deployment of documentation
• 7. Developing modules for the DIMS CLI app (dimscli)
  • 7.1. Bootstrapping the dimscli app for development
  • 7.2. Command Structure
  • 7.3. Completing commands in dimscli
  • 7.4. Adding New Columns to Output
  • 7.5. Adding New Commands
  • 7.6. Adding a Module in Another Repo
• 8. Service Discovery Using Consul
• 9. Debugging and Development
  • 9.1. Determining File System Affects of Running Programs
• 10. Docker Datacenter
  • 10.1. Datacenter Walk-thru
  • 10.2. Further Information
• 11. License

Section author: Dave Dittrich dittrich@u.washington.edu

Copyright © 2014-2016 University of Washington. All rights reserved.