jupyterhub/repo2docker

`start` script needs more documentation

Open

#398 opened on Sep 14, 2018

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (1,544 stars) (358 forks)batch import
documentationgood first issuehacktoberfest

Description

As part of #363 we did not add documentation that explains how to use the start script.

We should at least add it to https://repo2docker.readthedocs.io/en/latest/config_files.html

Contributor guide

Tech stack
pythondocker
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.
under 1 hour
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.
clear
Prerequisites
Basic familiarity with repo2docker
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Examine issue #363 for context on the implemented start script feature. Then, add a documentation section explaining how to use the start script to the config files page at https://repo2docker.readthedocs.io/en/latest/config files.html. Follow the existing documentation style and provide clear usage instructions.