NASA-AMMOS / NASA-AMMOS/AIT-Core
Add example of all config options in default config.yaml
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 56
- Forks
- 35
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 3
Description
It would be helpful to specify example values for all of our valid configuration options in config.yaml to help new people when they're exploring the toolkit. For example, we don't show how to set the script directory via script.directory or the HTML/static directory for the GUI via gui.html.directory
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the default config.yaml and identify the valid configuration options that currently lack example values, including script.directory and gui.html.directory. Update the file so every valid option has an example, then review it for completeness and valid YAML syntax.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100