gchq / gchq/sleeper

Evaluate basic example for values to include

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

Description

The full example can include every property, but without any values set. This is similar to how the template files are now.

The basic example can include a subset of the properties that are each worth having the user look at, because it's more likely they'll want to set them. For example, it's likely the user will want to set the optional stacks property, rather than leave it as the default. We can triage all of the properties in the system to decide what should be included.

Contributor guide

Open the contributing guide

Research direction

Start by locating the full example, basic example, and current template files referenced in the issue, then inventory the system properties they expose. Compare which properties users are most likely to set, and consider the work complete when the properties for the basic example have been agreed and the example reflects that selection.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.