it-at-m / it-at-m/refarch

[Documentation] Document template properties

Open
#494 3 comments 0 reactions 0 assignees View on GitHub
Type: Documentation
Dominant language
Java
Stars
7
Forks
5
Avg merge
2d 4h
Merged PRs (30d)
34

Description

### Relevant documentation

refarch-templates

### Problem description (optional)

For the gateway the available configuration options are documented: https://refarch.oss.muenchen.de/gateway.html#configuration
For the templates something similar is currently missing and only the `application-local.yaml` contains examples (but also not mentioned in docs).

### Desired solution

It should be documented what configuration properties are available and which are required.
Either by adding an additional section for the configuration (like for the gateway) or by making clear, that the `application-local.yaml` is the example configuration.

### Additional context (optional)

_No response_

### No duplicate

- [x] I confirm that this issue is not a duplicate

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with the refarch-templates documentation and inspect application-local.yaml for the configuration examples. Compare the existing gateway configuration section, then document the available and required template properties or clearly identify application-local.yaml as the example configuration; done means the properties and requirements are discoverable in the documentation.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.