voila-dashboards/voila

Voila.ip option not in documentation and -h help string

Open

#447 opened on Oct 25, 2019

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Python (487 forks)batch import
documentationgood first issue

Repository metrics

Stars
 (5,040 stars)
PR merge metrics
 (Avg merge 39d 17h) (1 merged PR in 30d)

Description

Follow up from #443

Viola has an option to serve the dashboard on a public interface using the voila.ip parameter. However this is not mentioned in the documentation which only refers to serving on localhost,
It is also not referenced in the voila help string -h.. -h only refers to the port, but not the IP address.

The option should be added to the documentation and the help string.

Contributor guide

Research direction
Examine the current help string defined in the Voila CLI (likely in a Python file such as `voila/app.py`) and the documentation (e.g., Readme or docs folder) to find where to add the ` voila.ip` option.
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