kit-data-manager / kit-data-manager/pit-service

Documentation 'How to start' is misleading

Open
#186 5 comments 0 reactions 2 assignees Claimed by @ThomasJejkal View on GitHub
documentation
Dominant language
Java
Stars
3
Forks
4
PR merge metrics
No merged PRs in 30d

Description

**Describe the bug**
I followed the 'How to start' instructions and unfortunately it didn't work.

**To Reproduce**
Steps to reproduce the behavior:
1. Checkout repo
2. Execute './gradlew build'
3. Copy config/application.properties to project folder ('cp config/application.properties .')
4. Start service ('./builds/libs/TypedPIDMaker-2.1.0.jar')

**Expected behavior**
The documentation should be correct. ;-)
The file 'application.properties' has to be placed in the same folder as
the jar file or in a subdirectory of this folder called 'config'.
Otherwise the properties file will not be found.

:information_source: **Note:**
As './gradlew clean build' will delete your settings its ***not*** recommended
to copy the config file into builds/libs directory!

:information_source: **Note:**
Typo: The file 'conf/application.properties' doesn't exist.

:information_source: **Note:**
It's ***not*** recommended to commit application.properties. It should be renamed (e.g.: application-default.properties') to avoid accidentally submitting credentials to Github.

:information_source: **Note:**
And last but not least the documentation should be also fixed at https://kit-data-manager.github.io/webpage/typed-pid-maker/installation.html

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.