docs: add note on memory limit to avoid java args break and fix typo #636
Conversation
This file contains 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
iromli
requested changes
Apr 26, 2024
| @@ -1132,7 +1132,7 @@ oxauth: | |||
| limits: | |||
| # -- CPU limit. | |||
| cpu: 2500m | |||
| # -- Memory limit. | |||
| # -- Memory limit. This value is used to pass java-arguments, so please use `Mi`. | |||
There was a problem hiding this comment.
I think the following sentence will be more appropriate:
This value is used to calculate memory allocation for Java application. Currently only supports `Mi`.
iromli
requested changes
Apr 29, 2024
| @@ -1132,7 +1132,7 @@ oxauth: | |||
| limits: | |||
| # -- CPU limit. | |||
| cpu: 2500m | |||
| # -- Memory limit. | |||
| # -- Memory limit. This value is used to calculate memory allocation for Java. Currently it only supports `Mi`. Please refrain from using other units. | |||
There was a problem hiding this comment.
The comments should be reflected to README.md. Use helm docs to autogenerate the docs.
iromli
approved these changes
Apr 29, 2024
iromli
approved these changes
May 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.