-
Notifications
You must be signed in to change notification settings - Fork 176
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Go over all OPAL's config variables and add descriptions #40
Comments
Want me to handle the project's documentation @asafc ? |
@money8203 for sure, we'd appreciate a hand - you can find the relevant files here: |
So what in specific do I have to add or document ? |
As you can see each config value is defined via confi - e.g. calls to Some of these can be deduced from the variable name, some from the comments in the code, and some would require reading the code itself to explain. |
#358 |
/bounty 50 |
💎 $50 bounty • Permit.ioSteps to solve:
Thank you for contributing to permitio/opal! Add a bounty • Share on socials
|
Is this issue still open? I see a PR merged on it @gemanor |
@Bhavyajain21 we added new acceptance criteria, see the first message in the thread |
/attempt #40
|
💡 @onyedikachi-david submitted a pull request that claims the bounty. You can visit your bounty board to reward. |
@gemanor can i work on this, i see a working pr already? |
Confi (our configuration lib) allows each config var to have a description string. All strings should be well explained and documented.
The acceptance criteria for this issue (updated September 2024):
confi
variables in the following configuration filesConfig files:
https://github.com/permitio/opal/blob/master/packages/opal-common/opal_common/config.py
https://github.com/permitio/opal/blob/master/packages/opal-client/opal_client/config.py
https://github.com/permitio/opal/blob/master/packages/opal-server/opal_server/config.py
The text was updated successfully, but these errors were encountered: