apache / apache/polaris

Provide empty configuration file (`application.properties`) in the binary distribution

Open
#2,686 0 comments 1 reaction 0 assignees View on GitHub
enhancement
Dominant language
Java
Stars
2.1k
Forks
522
Avg merge
1d 22h
Merged PRs (30d)
137

Description

The documentation lists the useful configuration properties for Polaris: https://polaris.apache.org/releases/1.1.0/configuration/

This documentation also mentions how the configuration properties can be set. Especially, it says:

```
3. Settings in $PWD/config/application.properties file.
```

But I think it's confusing for users regarding the binary distribution, because they actually have to create (if needed), `server/config/application.properties` and `admin/config/application.properties`.

I propose:
1. To update the documentation to clearly mention the right `application.properties` locations (in `server` and `admin`).
2. To provide `server/config/application.properties` and `admin/config/application.properties` in the binary distribution (empty, with all properties commented).

Contributor guide

Open the contributing guide

Research direction

Start with the linked configuration documentation and inspect the binary distribution layout for the server and admin directories. Update the documentation to name both application.properties locations, add empty files with commented properties to the distribution, and verify the resulting archive contains server/config/application.properties and admin/config/application.properties.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.