gchq / gchq/sleeper

Review property ordering in basic configuration example

Open
#7,670 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Java
Stars
107
Forks
29
Avg merge
19h 46m
Merged PRs (30d)
141

Description

We'd like to review whether the properties included in the basic configuration example are in the appropriate logical order.

There's one property that has a section heading, but it's the only property under that heading (`sleeper.logging.level`).

We can consider reordering them in the property definitions file, reorganising property groups, or making a specific ordering or grouping for the basic example in GeneratePropertiesTemplates.

Contributor guide

Open the contributing guide

Research direction

Start by locating the property definitions file and the GeneratePropertiesTemplates entry point, then inspect how the basic configuration example derives its property order and headings. Review the current grouping, especially the lone sleeper.logging.level section, and consider the stated ordering options; done means the example has a logical, consistent arrangement with no inappropriate single-property grouping.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.