logo

The Turing Way

  • Welcome
  • Guide for Reproducible Research
    • Overview
      • Definitions
      • Added Advantages
      • Barriers
      • Resources
    • Open Research
      • Open Data
      • Open Source Software
      • Open Hardware
      • Open Access
      • Open Notebooks
      • Open Scholarship
      • Checklist
      • Resources
    • Version Control
      • General Workflow
      • Getting Started with Git
      • Git Commit Command
      • Retrieving and Comparing Versions
      • Git Branches
      • Merging Branches in Git
      • Interactive, Visual Git
      • Git Commands to Work on GitHub
      • Summary Table of Git Commands
      • Version Control for Data
      • Personal Stories
      • Checklist
      • Resources
    • Licensing
      • Software Licenses
      • License Compatibililty
      • Data Licenses
      • Checklist
    • Research Data Management
      • Research Data
      • Data Management Plan
      • The FAIR Principles and Practices
      • Personal data management
      • Data Storage and Organisation
      • Data Organisation in Spreadsheets
      • Documentation and Metadata
      • Sharing and Archiving Data
      • Data Article
      • Research Data Management Toolkits
      • Personal Impact Stories
      • Checklist
      • Resources
    • Reproducible Environments
      • Capturing Computational Environments
      • Package Management Systems
      • YAML
      • Virtual Machines
      • Containers
      • Resources and Checklist
    • BinderHub
      • Introduction to BinderHub
      • Compute Resources
      • Build Your Own BinderHub
      • Resources for BinderHub
    • Code quality
      • Code Style and Formatting
      • Checklist and Resources
    • Code Testing
      • General Guidance for Testing
      • Overview of Testing Types
      • Smoke Testing
      • Unit Testing
      • Integration Testing
      • System Testing
      • Acceptance and Regression Testing
      • Runtime Testing
      • Test Driven Development
      • Challenges and Exceptional Cases
      • Checklist for Code Testing
      • Further Recommendations
    • Code Reviewing Process
      • Motivation for code reviewing
      • Recommendations for code reviewing
      • Code review workflow
      • Checklist for code reviewing
      • Resources for code reviewing
    • Reusable Code
      • Overview of Code Reuse
      • Detailed Recommendations for Code Reuse
    • Continuous Integration (CI)
      • Intro to Continuous integration (CI)
      • Getting started with GitHub actions
      • Building a Block of a GitHub actions
      • Best practices and recommendations
      • Checklist and Resources
    • Reproducible Research with Make
      • Learn "Make" by examples
      • Debugging Makefiles
      • Case Study of a Reproducible Paper
      • Including numerical results and tables
      • Resources for "Make"
      • Appendix
    • Research Compendia
    • Risk Assessment
      • Complexity and Impact of Risk Assessment
      • Summary of Risk Assessment
    • Case Studies
      • A Statistical Methods Manuscript
  • Guide for Project Design
    • Overview of Project Design
      • Planning for Project Design
      • Communication and Collaboration
      • Reproducibility Methods
      • Version Control and Documentation
      • Sharing Your Research Work
    • Creating Project Repositories
      • Landing Page - README File
      • Roadmapping
      • Contributors and Communication Pathways
      • Participation Guidelines
      • Advanced Structure for Data Analysis
      • Further Recommendations
    • Personas and Pathways
      • Persona Creation Tool
      • Contributor Pathways
    • File Naming Convention
    • Code Styling and Linting
      • Guidelines for Code Styling
      • Writing Human Readable Code
      • Code Styling Tools
  • Guide for Communication
    • Overview of Guide for Communication
      • Principles of Communicating with Wider Audiences
      • Communicating Accessibly
      • Resources and Recommendations
    • Blogs for Research Communication
      • Building a Webpage for Blogs
      • Personal stories - Blogs
    • Lay Summaries
      • Personal Stories - Lay summaries
    • Podcasts for Research Communication
      • Personal Stories - Podcasts
    • Presenting Posters and Conference Talks
      • Presenting at Remote Events
      • Personal stories - Presenting Outside of Your Discipline
    • Social Media for Research Communications
      • Tips for starting with twitter
      • Managing multiple twitter accounts
    • Making Research Objects Citable
      • Steps for Making Research Objects Citable
      • Citing Research Objects
      • Software citation with CITATION.cff
      • Create a CITATION.cff using CFFinit
      • Linking Research Objects
      • ORCID to Collect your Research Objects
      • Checklists and Resources
    • Communications in Open Source Projects
      • Issue Tracking
      • Communication Channels
    • Authorship and Contributions on Academic Articles
      • Overview of Academic Authorship
      • Types of Authorship Misconduct
      • Discipline Specific Authorship Traditions
      • Large and Equitable Authorships
      • Tips on How to Get Authorship Right
      • Personal Stories - Authorship on Interdisciplinary Projects
      • Personal Stories - Large Collaborative Research Community
      • Resources
    • Peer Review
      • Peer Review
      • Guidance on Peer Review for a Journal
      • Resources
    • Binder
      • Zero-to-Binder
  • Guide for Collaboration
    • Getting Started With GitHub
      • Motivation for Using GitHub
      • First steps on GitHub
      • Using more GitHub features
      • Advanced GitHub features
    • Maintainers and Reviewers on GitHub
      • Project Maintenance
      • Ownership and Permissions
      • Reviewing Contributions
      • Merging Contributions
      • Resources
    • Managing a New Community and Team
      • Guide to Planning a Community
      • Addressing Technical Issues
      • Valuing Diversity and Differences
      • Teamwork
    • Research Infrastructure Roles
      • Community Managers Overview
      • Data Stewards Overview
      • Data Steward Case Study
      • Research Software Engineers Overview
      • Research Application Manager Overview
    • Leadership in Research and Data Science
      • Important Features of Leadership
      • Open and Healthy Leadership
      • Creating Leadership Structure
      • Creating Leadership Opportunities
      • What to Avoid in Leadership
      • Personal Story from Running a Hackathon
      • Personal Story by a Data Librarian
    • Remote Collaboration
      • Organising Remote Meetings
      • Guidelines for Remote Collaboration
      • Tools for Remote Collaboration
      • Organising Online Coworking Calls
      • Organising Remote Conferences
      • Chairing Remote Events
      • Participating in Remote Events
      • Managing Distributed Teams
      • Informal Coffee Chats
      • Perceived Pros and Cons
    • Shared Ownership in Open Source Projects
      • Project Ownership
      • Shared Ownership Models
      • Challenges with Applying Ownership Models Retroactively
      • Nudging for a Better Default
  • Guide for Ethical Research
    • Introduction to Research Ethics
    • Research Ethics Committees Workflows
    • Ethical Decisions in Preclinical Research
    • Law, Policy and Human Rights in Ethics
      • Ethics and law
      • Human rights
      • Further Recommendations
    • Activism for Researchers
      • Unionisation
      • Whistleblowing
      • Case study - Robodebt
      • Case study - Google Workers
    • Internal Policy Advocacy
    • Self-Reflection
      • Identity and Positionality
      • Power and Privilege
      • Self-Reflection Prompts
      • Resources
  • Community Handbook
    • Code of Conduct
      • Code of Conduct in Detail
      • Incident Reporting Guideline
      • Enforcement Manual
      • Acknowledgements
    • Style Guide
      • Citing and Referencing External Resources
      • Cross-Referencing Sections and Chapters
      • Using Figures
      • Glossary, Special Blocks and More Styling
      • Custom Styling
    • Maintaining Consistency
      • Formatting
      • Structure
      • Language
    • Contributing and Developing Chapters - Templates and Workflow
      • Templates
      • Workflow
    • Acknowledging Contributors
      • Community Members and Shared Ownership
      • Record of Contributions
      • Different Contributions and Acknowledgements
    • Monthly Newsletters
      • A Process of Creating a newsletter
      • Newsletter's Style Guide
      • The Turing Way Newsletter Template
    • Book Dash Events
      • Application and Review Process
      • Book Dash Logistics
      • Participant Selection Process
      • Book Dash Main Event Plans
      • After the Book Dash
    • Community Coworking Calls
      • Background, Motivations, and Techniques
      • Online Collaboration Cafe
      • Weekly Coworking Calls
      • Organising coworking calls
    • Fireside Chat Series
    • Template Collection
      • Book Dash Main Shared Document
      • Book Dash Pre-event Onboarding
      • Book Dash GitHub Session
      • Book Dash Template for Shared Notes
      • Book Dash Template for Feedback
      • Online Collaboration Cafe Templates
      • Weekly Coworking Call Template
      • Template for Drafting Newsletters
      • Template for Fireside Chat Shared Notes
  • Afterword
    • Legal Disclaimer
    • Glossary
    • Bibliography
    • Record of Contributions
Visit our GitHub Repository
This book is powered by Jupyter Book
Contents
  • Further reading
  • References specific for this chapter

Resources

Contents

  • Further reading
  • References specific for this chapter

Resources¶

Further reading¶

  • Binder documentation

  • BinderHub documentation

  • Zero-to-JupyterHub with Kubernetes documentation

  • JupyterHub documentation

  • The Turing Way Build a BinderHub Workshop

References specific for this chapter¶

  • Kubernetes documentation: https://kubernetes.io/

  • Helm documentation: https://helm.sh/

  • repo2docker: https://repo2docker.readthedocs.io/en/latest/?badge=latest

  • Microsoft Azure documentation on Role Based Access Control: https://docs.microsoft.com/en-us/azure/role-based-access-control/overview

previous

Build your own BinderHub

next

Code Quality

By The Turing Way Community
© Copyright 2020-2021.