Welcome to the MIT Libraries Developer Documentation site.

While this site is public and you are welcome to use it, our main goals are internally facing. That said, feel free to open an Issue if you have suggestions or feedback.

• Search Page

Start Here

• Accessibility
  • Background info
  • Goals
  • Local software projects
  • Implementing open source or vended solutions
  • Resources
• GitHub
  • Repo naming
  • Recommended repo settings
  • Workflows
  • Merging and Rebasing
  • Pull Requests
  • Github and JIRA
  • GitHub and Code Climate
  • Updating the default branch in GitHub
  • GitHub basics
  • Advanced topics
• GitHub Desktop
  • Cloning
  • Syncing your local repo
  • Creating a branch
  • Making changes
  • Commits
  • Pushing changes
  • Pull requests

How We Work Together

• Code review
  • Before opening a pull request
  • Opening a pull request
  • The review process
  • Merging code
• Pair programming
  • When to pair (and when not to)
  • Goals
  • Mechanics
  • Readings

Languages and Frameworks

• Python Guidelines
  • Python versions
  • Creating a project from templates
  • Style and coding Conventions
  • Dependencies
  • Project Documentation
  • Testing
• Rails at MIT Libraries
  • Style and Conventions
  • Test Frameworks
  • Continuous Integration
  • Rails Development Environment
  • Deployments
  • Ruby Versions
  • Rails Versions
  • Upgrading Ruby on Rails and Deprecations
  • Gems and Updates
  • Layout and Styles
  • Authentication
  • Authorization
• Vue.js at MIT Libraries
  • Style and Conventions
  • Test Frameworks
  • Continuous Integration
  • Package manager
  • Development Environment
  • Deployments
  • Vue Versions
  • Dependency Updates
  • Layout and Styles
  • Authentication
  • Authorization
• WordPress at MIT Libraries
  • Deployments
  • Upgrading
  • Database migrations
  • Locally Developed Code
  • Integrations

Authentication

• OAuth at MIT (deprecated)
  • Code you can reuse
  • Policy
• Touchstone / Shibboleth / SAML
  • What is Touchstone?
  • What is Shibboleth?
  • What is SAML?
  • What are we doing here?
  • Registering a SAML SP in MIT Touchstone

Deployment

• Airflow: workflow engine
• AWS Organization
  • Getting Started
  • AWS Org Accounts
  • Access
• Continuous Integration/Deployment
  • Overview
  • Testing
  • AWS 2.0 Fargate/Lambda Deployment
  • Legacy AWS Fargate Deployment
• Heroku
  • What’s weird about Heroku at first?
  • Billing
  • Pipelines
  • Setting up a new pipeline
  • Production Deploy with Pipelines Cheatsheet
  • Manual Deploys
  • Viewing / changing Environment Variables
  • Deploy Hooks
  • Dynos
  • Domain Names and SSL
  • MIT Authentication
• Heroku Launch Checklist
  • Setup Pipelines
  • Configure Dynos
  • Configure Database Backups
  • Ship logs
  • DNS and SSL
  • Configuration
• Legacy AWS
  • Getting Started
  • Creating a new Moira-based Role
  • Weird Things
• Legacy Terraform
  • Getting Started
  • Workspaces
  • Modules
  • Variables
• Pantheon
  • Multidev workflow
  • Legacy workflow
  • WebOps workflow
• Terraform
  • Getting Started
  • GitHub
  • Terraform Cloud
  • Terraform CLI (local)
  • Modules
  • Variables
  • Repositories in detail

Everything else

• Architecture Decision Records
  • Format
  • Notes
• Diagramming Guidelines
  • Who is the intended audience
  • When do we create diagrams
  • Where do we use diagrams
  • Why do we need diagrams
• Containerizing Your App
  • Dockerfile Guidelines
  • ENTRYPOINT/CMD
  • .dockerignore
  • Example Dockerfiles
• Exception Monitoring
  • What software needs Exception Monitoring
  • What are we using for Exception Monitoring
  • How do I get an account?
  • How can I add Sentry to my application
  • How can I add Sentry to my Rails application
  • How can I add Sentry to my JavaScript features in my Rails application
  • How can I add Sentry to my Python application
  • How can I add Sentry to my PHP application
• Incident Response Guidelines
  • What is an incident response?
  • What requires an incident response?
  • Who should write them?
  • What goes in a report?
  • Where do I get a template?
  • How do I submit my completed report?
  • Additional reading:
• Central Logging
  • Logging Standards
  • Requirements
  • Access
• Configuring apps to use Matomo for analytics
  • For Rails applications hosted on Heroku
  • For the WordPress network hosted on Pantheon
  • For LibGuides and another LibApps products
  • For static sites
  • For DSpace@MIT
  • For Dome
  • Other things to note
• Proxy URLs
  • tl;dr
  • What is a proxy URL?
  • Why use a proxy URL?
  • Configuration Reqirements
  • How EZproxy works
• SSL Encryption