Development

If you’d like to contribute to Orchest development, then the following sections should help you get up to speed on our development setup, contributor guidelines and implementation details.

Development

• Contributing to Orchest
  • Contributor License Agreement
• Development workflow
  • Prerequisites
  • Installing Orchest for development
  • Redeploying Orchest after code changes
  • Making changes
  • Example VS Code monorepo set-up
  • Automated tests
  • Manual testing
• Troubleshooting
  • Minikube is unresponsive on Docker Desktop
  • Inspecting the orchest-api API schema
  • Inspecting the orchest-database
  • Breaking schema changes
  • Dev mode not working
  • Can’t log-in to authentication enabled instance
  • Missing environment variables in pods
• Concepts in Orchest
  • High-level overview
  • Concepts
  • Putting it all together
• Implementation details
  • Orchest Controller
  • Telemetry Events
  • orchest-api events
  • SDK data passing
  • Internally used environment variables
  • Building environment and custom jupyter images
  • Pod scheduling in Orchest
  • Git config and SSH keys injection
• Implementation best practices
  • API design guidelines
  • React
  • Flask
  • userdir
  • Writing docs
• Miscellaneous appendix
  • /userdir paths
  • Pipeline definition JSON