MetOffice / MetOffice/ANTS

Better documentation for configuring ANTS

Open
#131 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

📚 documentation
Dominant language
Python
Stars
7
Forks
10
Avg merge
1d 19h
Merged PRs (30d)
5

Description

# 📚 Documentation Request

## Addition
The ANTS configuration options are in the [API docs](https://metoffice.github.io/ANTS/lib/ants.html#module-ants.config). It would be good if:

1. These were more prominent and discoverable. Some of these configuration settings are too important to be buried this far in the docs.
2. The docs for each config option look good. But pulling them out into the main docs rather than a code block would enable e.g. linking to a configuration option in response to a support request.

## Clarification

In general, the configuration options documentation could use a bit of a refresh. This is separate from any code restructuring to e.g. consolidate the use of configuration files, environment variables, and command line arguments in an application interface refresh.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the configuration section in the ANTS API docs at ants.html#module-ants.config and inspect how the current options are presented. Identify the main documentation location where configuration guidance belongs, then make the options more discoverable and individually linkable without restructuring configuration code. Done means the refreshed documentation clearly exposes the options outside the current code block and preserves their existing descriptions.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.