nbcollection & nbcollection-ci

nbcollection-ci

nbcollection-ci provides a set of tools to streamline the Scientific Review process of Jupyter Notebooks. Designed through collaboration between astropy, STScI DSMO, and SPB. This repository exists to automate as many administrative tasks as possbile for an engineer or scientist looking to enhance a Github Pull Request review process.

nbcollection-ci shipping with the ability to install Build Machinery, enhancing your Github Repository with a complete CI/CD solution utilizing CircleCI. There is planned support for Github Actions.

See Also

• Getting Started
  • How to install
  • How to manage a Pull Request
  • How to manage Main Branch
  • How to generate a website from Main Branch builds
• Installing Build Machinery
  • Creating Github Repository, Setting up CircleCI, Creating Content
    • Creating a Github Repository
    • Inserting content into the newly created Github Repository
    • Enabling CircleCI
    • Installing Build Machinery
  • Checking our work
• Deploying a website using Github Pages
  • Generating a Themed Website
• Architecture, Terminology & API Introductions
  • Software Support
  • Terminology
  • CI/CD Checks and Utilities
  • Modules and Concepts
    • Scanner Module API
    • Metadata Module API
    • Generate CI Environment
    • Merge Artifacts
    • Build Notebooks
    • Pull Request
    • Site Deployment
    • Sync Notebooks