Add configuration notes to README.md #964
Conversation
dimas-b
requested review from
adutra,
ashvina,
dennishuo,
eric-maynard,
jackye1995,
jbonofre,
vvcephei,
collado-mike,
snazy,
RussellSpitzer,
takidau,
MonkeyCanCode,
flyrain and
ebyhr
as code owners
|
CC: @dennishuo |
| Please see the [Configuration Guide](https://polaris.apache.org/in-dev/unreleased/configuration/) | ||
| for more information. | ||
|
|
||
| Default configuration values can be found in `quarkus/defaults/src/main/resources/application.properties`. |
There was a problem hiding this comment.
Not a blocker to this PR, but I'm still concerned as this file contains both build-time and runtime configs. I'm not sure if there is a better way to reduce the confusion from the users, other than documenting them well. Open for suggestions.
There was a problem hiding this comment.
Would it help if we had a different section for build-time properties in application.properties with a comment explaining how they work?
There was a problem hiding this comment.
yeah, that definitely helps.
Co-authored-by: Honah J. <[email protected]>
README.md
Outdated
| #### Configuring Polaris | ||
|
|
||
| Polaris Servers can be configured using a variety of ways. | ||
| Please see the [Configuration Guide](https://polaris.apache.org/in-dev/unreleased/configuration/) |
There was a problem hiding this comment.
Can we use relative path here as well?
There was a problem hiding this comment.
I'm not sure. I suppose people often view this README on GH or locally.
There was a problem hiding this comment.
I have test a relative path as the following. Either GH and local(in IDE) usage are fine. Just a bit concern of inconsistency, as once we got releases. A link like this https://polaris.apache.org/in-dev/unreleased/configuration/ will be changed.
- See [README in `site/`](site/README.md) for more information.
There was a problem hiding this comment.
Changed to a relative link to configuration.md. This is a link between .md files, not to the generated docs, but that works for me.
No description provided.