jupyterhub/repo2docker

`start` script needs more documentation

Open

#398 opened on 2018年9月14日

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

説明

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

コントリビューターガイド

技術スタック
pythondocker
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Basic familiarity with repo2docker
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
80
調査方針
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.