Skip to content
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

Open
asafc opened this issue Apr 14, 2021 · 12 comments · May be fixed by #682
Open

Go over all OPAL's config variables and add descriptions #40

asafc opened this issue Apr 14, 2021 · 12 comments · May be fixed by #682
Labels
💎 Bounty documentation Improvements or additions to documentation hacktoberfest

Comments

@asafc
Copy link
Contributor

asafc commented Apr 14, 2021

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):

  • Add a test that fails in case of missing description attribute in any of the confi variables in the following configuration files
  • Ensure the test is passing
  • Add descriptive description to any of the missing description attributes

Config 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

@asafc asafc added the documentation Improvements or additions to documentation label Apr 14, 2021
@asafc asafc self-assigned this Apr 14, 2021
@money8203
Copy link
Contributor

money8203 commented Jan 16, 2023

Want me to handle the project's documentation @asafc ?

@money8203
Copy link
Contributor

So what in specific do I have to add or document ?

@orweis
Copy link
Contributor

orweis commented Jan 17, 2023

As you can see each config value is defined via confi - e.g. calls to confi.model() or confi.bool()
Some of these are missing the "description" argument - which should contain human readable text explaining about the configuration value.

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.

@money8203
Copy link
Contributor

money8203 commented Jan 17, 2023

roekatz added a commit that referenced this issue Jun 9, 2023
@gemanor
Copy link
Collaborator

gemanor commented Sep 30, 2024

/bounty 50

Copy link

algora-pbc bot commented Sep 30, 2024

💎 $50 bounty • Permit.io

Steps to solve:

  1. Start working: Comment /attempt #40 with your implementation plan
  2. Submit work: Create a pull request including /claim #40 in the PR body to claim the bounty
  3. Receive payment: 100% of the bounty is received 2-5 days post-reward. Make sure you are eligible for payouts

Thank you for contributing to permitio/opal!

Add a bountyShare on socials

Attempt Started (GMT+0) Solution
🟢 @onyedikachi-david Oct 11, 2024, 1:00:05 PM #682

@Bhavyajain21
Copy link

Bhavyajain21 commented Sep 30, 2024

Is this issue still open? I see a PR merged on it @gemanor

@gemanor
Copy link
Collaborator

gemanor commented Sep 30, 2024

@Bhavyajain21 we added new acceptance criteria, see the first message in the thread

@onyedikachi-david
Copy link

onyedikachi-david commented Oct 11, 2024

/attempt #40

Algora profile Completed bounties Tech Active attempts Options
@onyedikachi-david 9 bounties from 4 projects
TypeScript, Python,
JavaScript & more
Cancel attempt

Copy link

algora-pbc bot commented Oct 11, 2024

💡 @onyedikachi-david submitted a pull request that claims the bounty. You can visit your bounty board to reward.

@Abiji-2020
Copy link

@gemanor can i work on this, i see a working pr already?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💎 Bounty documentation Improvements or additions to documentation hacktoberfest
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants