blue-oil/blueoil

No config yaml reference at documentation site

Open

#112 opened on Jan 18, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (250 stars) (85 forks)batch import
documentationhelp wanted

Description

There are no config yaml reference at documentation web site. Need to write what option can use, which parameter can select in the option, like this: https://docs.docker.com/compose/compose-file/compose-file-v1/

Contributor guide

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.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
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
YAML basicsblueoil configuration knowledge
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Check the blueoil documentation site for existing structure. Review the config.yaml files in the repository to understand available options. Create a new page listing all configuration parameters with descriptions, examples, and valid values.