Netflix/metaflow-docs

Improve documentation around resume

Open

#38 opened on Apr 13, 2022

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (64 forks)auto 404
good first issuehelp wanted

Repository metrics

Stars
 (38 stars)
PR merge metrics
 (PR metrics pending)

Description

The resume command is a powerful one but a lot of people only consider it when something failed (if then). resume, however, can be used for other things and not necessarily when things have failed (you may want, for example, to reuse some initial steps and change the end). Improving documentation around these use cases may be useful to users.

Contributor guide

Research direction
Review existing documentation for the resume command and identify areas where use cases beyond failure recovery can be highlighted. Consider adding examples of using resume for partial reprocessing or reusing steps.
Tech stack
None
Domain
data
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80