Development Guide

• Developer docs
  • Installation
  • Configuration
  • Why QHub
  • Staging & Production Environments and Shell Access
  • QHub Architecture
  • Cloud Deployment on QHub
• Contribution Guidelines
• Additions
  • Adding new Integration and Features to Qhub
• Release Process for QHub
  • Pre-release Checklist
  • Release
• Tips for Testing
  • Using a development branch
  • Modifying Docker Images
  • Linting Dockerfiles
  • Debug Kubernetes clusters
  • Cypress Tests
  • Deployment and integration tests
• Cloud Testing
• Docs testing
• Links Testing
• Minikube
  • Compatibility
  • Dependencies
  • Initialize Kubernetes cluster
  • Optional pre-pulling and caching of Docker images
  • MetalLB
  • Automation of MetalLB with Python script
  • Note for development on Windows Subsystem for Linux 2
  • Deploy QHub
  • Initialize configuration
  • Deploy and render the infrastructure
  • Verify the local deployment
  • Cleanup
• Minikube on Mac
• Minikube on AWS
  • Set up AWS credentials
  • Create a Key Pair
  • Run the EC2 instance
  • Open SSH port access
  • SSH into the instance
  • Install Minikube etc
  • Initialize and deploy QHub
  • Enable Kubernetes access from Mac
  • Access the full QHub website
• Keycloak Testing
  • Run Keycloak in Docker
  • Configure Keycloak
  • Understanding JupyterHub OAuth2
  • Testing OAuth2 using Postman
• Changelog
  • Upcoming Release
  • Release v0.4.2 - June 8. 2022
  • Release v0.4.1 - May 10. 2022
  • Release v0.4.0.post1 - April 7, 2022
  • Release v0.4.0 - March 17, 2022
  • Release 0.3.13 - October 13, 2021
  • Release 0.3.11 - May 7, 2021
  • Release 0.3.10 - May 6, 2021
  • Release 0.3.9 - May 5, 2021
  • Release 0.3.8 - May 5, 2021
  • Release 0.3.7 - April 30, 2021
  • Release 0.3.6 - April 29, 2021
  • Release 0.3.5 - April 28, 2021
  • Release 0.3.4 - April 27, 2021
  • Release 0.3.3 - April 27, 2021
  • Release 0.3.2 - April 20, 2021
  • Release 0.3.1 - April 20, 2021
  • Release 0.3.0 - April 14, 2021
  • Release 0.2.3 - February 5, 2021
  • Thank you for your contributions!
• Logos and Icons
  • Quansight
  • Quansight Labs
  • Qhub Cloud

previous

Frequently asked questions

next

Developer docs