docs(config): add descriptions to all configuration variables and tests #682
+418
−175
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
Signed-off-by: David Anyatonwu <[email protected]>
Signed-off-by: David Anyatonwu <[email protected]>
✅ Deploy Preview for opal-docs canceled.
|
|
The PR is ready for review @gemanor |
gemanor
requested changes
Oct 13, 2024
| POLICY_STORE_URL = confi.str( | ||
| "POLICY_STORE_URL", | ||
| "http://localhost:8181", | ||
| description="URL of the policy store" |
There was a problem hiding this comment.
This is exactly what written on the key, please explain more...
| INLINE_OPA_ENABLED = confi.bool( | ||
| "INLINE_OPA_ENABLED", | ||
| True, | ||
| description="Whether to run OPA inline within OPAL" |
There was a problem hiding this comment.
Even the code comment has more description of this description. The task is to write descriptions of the variables, not just mark them as solved. Please do some understanding work around OPAL, and explain the configuration variables in a concise but descriptive way.
Signed-off-by: David Anyatonwu <[email protected]>
Done. |
|
@gemanor Please review. |
|
Hi @gemanor, I don't know if you have got time to review this. |
1 similar comment
|
Hi @gemanor, I don't know if you have got time to review this. |
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.
Closes #40
/claim #40
Changes proposed
Check List (Check all the applicable boxes)