jupyterhub/repo2docker

`start` script needs more documentation

Open

#398 opened on Sep 14, 2018

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

Repository metrics

Stars
 (1,544 stars)
PR merge metrics
 (Avg merge 17h 41m) (2 merged PRs in 30d)

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

Research direction
Read the existing documentation at config files.html, then write a section explaining the start script and how to use it.
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.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90