How do I create a CLR / QF round?
HOW TO : Setup a CLR round
This document outlines the steps needed to set up a CLR round for a client / for ourselves.
Do follow these steps religiously and do not stray away from it unless you know what you are doing.
Ground Rules:
- Do not delete/clear data from admin unless it is needed.
- Be extra careful while creating / updating and double check your changes cause a configuring things wrong could affect all the grants taking part in the round
- While setting images/ logo , understand where the image appears and set the dimensions.Use compressed images, DO NOT UPLOAD HEAVY FILES.
===============================
How do I create a CLR Round
- Head over to https://gitcoin.co/_administrationgrants/grantclr/
- Create a new entry (If you do not have permission -> ping Aditya) and keep these in mind while doing so
- Grant Filters : Decides what grants to included in CLR (eg : all grants with type matic and region east asia) [ If you don’t understand this, scroll down and this will be explained ]
URL for a CLR round is generated in the following format customer_name/round_num/sub_round_slug
- Customer Name: use same name if the customer has done a round with us
- Round Num: this is a number which specifies which round number (etc round 7, round 8)
- Sub round slug: url format of display text
- Display Text: What the round is called and what the user will see
- Owner: If you don’t know the owner -> default it to gitcoinco
- Is_active : DO NOT SET THIS TO TRUE UNLESS ROUND HAS STARTED
- Start + end date + total pot : Ensure these are set right
- Logo : this is the logo you see here on the landing page this is the background banner colors people will see when they go to /grants and view active clrs
- Dimensions: 1151 x 119 pixels, stripped of all data
Other fields which are present but you won’t need to edit mostly are
- Collection Filter : Decides what collections to included in CLR
- Subscription Filter
- Verified Threshold
- Unverified Threshold
- Multiplier (use this to saturate round quicker / slower)
NOTE
- If your CLR round is active and current date is between start and end date, you should see the new Grant CLR to appear on the grants landing and if customers want a dedicated grants page with no noise and just their grants. The URL you can share with them would be in the format customer_name/round_num/sub_round_slug (this is what you entered while creating the round)
- Be patient. Wait for some time (15 min worst case) for the algorithm run and include all the needed grants + do the CLR calculations
===============================
How do I set Grant Filters:
- First be clear on how the grouping to be done
- You can create a round including grants of
- same grant type(s) (community)
- Same grant region(s) (east-asia)
- A mix of grant types + grant categories + regions
- Here are a few examples:
Round for Grant Type matic
{"grant_type": "10"}
Round for Grant Type matic (id = 10) and community (id=2)
{"grant_type__in": ["2", "10"]}
Round for Grant Type matic (id = 10) , community (id=2) and region east_asia
{"region": "east_asia", "grant_type__in": ["2", "10"]}
Round for Grant Type matic (id = 10) ,and region east_asia
{"region": "east_asia", "grant_type": "10"}
If you need more complex, reach out to engineering and we’ll help you out
Dimensions: grant type logo needs to have an aspect ratio of 10:3
Logo: This is the create grant banner that shows up when you go and open new grants under grants/new and after selecting the proper category (created by the CLR round above)
===============================
What if new Customer wants to have a custom landing banner
We now know that CLR round URL would be of the format gitcoin.co/grants/clr/<customer_name>/<round_num>/<sub_round_slug>.An example here would be:
- Create a new entry
- Policy - make sure this is readable name
- URL pattern This is a regular expression. Any page user visits on gitcoin grants -> if it matches this expression -> the background image will display
If you aren’t sure what should happen here, stick to the format
/grants/?.*/[replace-with-customer_name].*
For above example it would be /grants/?.*/customer_name.*
If you would like further customization, ping Aditya and he’ll explain it better on how to use this
- Banner Image: This is the banner the user will see. Ensure this is not a big file cause bigger the file -> the slower the site will feel when the user is on this page
- Dimensions: (previous images were 2500 x 469 pixels / 2500 x 414 pixels), this is main banner image folks will see when navigating into the /grants/clr/customer_name urls
Other fields which are present but you won’t need to edit mostly are
- Background Image : used to set a custom background for the entire page
- Priority
- Inline css: If you need to tweak the background of the section with Create a Grant / Becoming a Matching Partner -> you will have to write custom CSS (you will need to hit up someone from engineering for this)
NOTE
- If you want to use the same logo for 2 diff CLR rounds -> DO NOT CREATE A NEW RECORD
- This can be done by tweaking the URL pattern field.
- Groups/categories on the sidebar will not visible until there is at least 1 grant on that type created. You can verify on grants/new if the type exist and the categories associated.
Example: /grants/?.*/(community|media).*
- Look at the other entries and you’ll be able to figure out how you can tweak the rule
===============================
What if an existing Customer wants to have a custom landing banner only for a specific round
- SAME AS ABOVE but you’ll have to ensure the URL pattern is unique only to that round. (Aditya can help with this)
- This won’t likely happen
===============================
How to create a Grant Type
- Create a new entry at https://gitcoin.co/_administrationgrants/granttype/
- Ensure
- is_active is set to true
- Name : this should be lower case and separated by _ Once this is set, PLEASE DO NOT UPDATE IT
- Label : this what the end user sees, this can be updated
- Categories: Select all categories that apply. If you don’t see a category you want to link. You will have to create it [ steps given below]
- Add a logo is possible ( this is what appears on the grants creation form, the customers logo will be presented on the creation form AKA might help merging
Grant Type (table in DB) -> is named as Grant Category (in UI)
Grant Category (table in DB) -> is named as Grant SubCategory (in UI)
===============================
How to create a Grant Category
- Head over to https://gitcoin.co/_administrationgrants/grantcategory/ and create a new entry.Once created , you should be able to go to the Grant Type and link the newly created category to the Grant Type.
It is as simple as that.
===============================