Clarify documentation of config sub-directory from which external application properties are read #32224
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spring-projects-issues
added
the
status: waiting-for-triage
wilkinsona
changed the title
Member
|
Thanks for spotting this, @obfischer, and raising a PR. I agree that |
wilkinsona
added
type: documentation
wilkinsona
added
the
status: waiting-for-feedback
Member
|
@obfischer any opinion about this? If you agree, we can also polish this as part of merging but we'd like to make sure the updated proposal addresses your concern. |
obfischer
force-pushed
the
improvement/clearify-path-of-config-directory
branch
from
1b3245f to
2863c4e
Compare
Author
|
I think @wilkinsona has a good point. I updated my pull request. |
The current documentation relates to the subdirectory for external configurations as `/config`. Read as UNIX path, the leading slash could be read as reference to the root directory `/`. Therefore I would suggest to use `./config` to make it a little bit more understandable. This is of course not a major issue, but IMHO makes it a little bit more understandable.
obfischer
force-pushed
the
improvement/clearify-path-of-config-directory
branch
from
2863c4e to
bbf4950
Compare
spring-projects-issues
added
status: feedback-provided
snicoll
pushed a commit
that referenced
this pull request
Sep 10, 2022
Currently, the documentation relates to the subdirectory for external configurations as `/config`. Read as UNIX path, the leading slash could be read as reference to the root directory `/`. This commit updates the documentation to use 'config/' instead. See gh-32224
Member
|
Thanks for the follow up and the contribution @obfischer |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current documentation relates to the subdirectory for external configurations as
/config. Read as UNIX path, the leading slash could be read as reference to the root directory/. Therefore I would suggest to use./configto make it a little bit more understandable.This is of course not a major issue, but IMHO makes it a little bit more understandable.