nteract/papermill

Guidance for how best to use papermill in a variety of situations that are common to industry

Open

#301 opened on Feb 4, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,381 stars) (402 forks)batch import
docshelp wantednew-contributor-friendly

Description

We don't have a home for guides or other advice on integration with other systems that works well or is easy to use.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonPapermill basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing papermill documentation to identify where guides could be added. Look at common industry use cases (e.g., scheduling with cron, cloud deployment). Propose a structure for a guides section and draft one example guide. Discuss with maintainers to narrow scope.