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 (5,040 stars) (487 forks)batch import
documentationgood first issue

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

Tech stack
python
Domain
documentationcli
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.
1-3 hours
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
PythonVoilà basicsCLI argument parsing
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75
Research direction
The issue requests adding the `voila.ip` option to the documentation and the help string. Review the documentation source files (likely under `docs/source/`) and the CLI argument definition in the Voilà codebase (e.g., `voila/app.py`). Check the referenced issue #443 for context. The help string is generated via argument parser; locate where the ` port` option is defined and add a similar entry for ` ip`. Update the documentation to include the IP option, possibly in the configuration section.