NASA-IMPACT / NASA-IMPACT/science-support

Revisit automated checking of notebooks

Open
#80 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
3
Forks
0
PR merge metrics
No merged PRs in 30d

Description

@choldgraf raised during some meetings that Pythia has somewhat functioning nightly notebook checks.
https://cookbooks.projectpythia.org/status/

We should revisit getting something working on VEDA and MAAP docs, so we at least know when things stop working.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing Pythia nightly notebook checks at https://cookbooks.projectpythia.org/status/ and then inspect the VEDA and MAAP documentation repositories or workflows. Determine how automated checks could cover both documentation sets and define completion as checks that report when notebooks stop working.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
ci-cd, documentation, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.