Skip to content

docs: fix typos in campaigns instruction documentation #2321

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.

Sign up for GitHub

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

Open
HusseinAdeiza wants to merge 1 commit into
base: staging
Choose a base branch
from
Open

docs: fix typos in campaigns instruction documentation #2321

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/campaignsInstruction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

* `SortField`: Sometimes in a campaign we just want to show projects in an specified order, for instance we can create a campaign like ** Check projects that received most likes** so for this campaign you set **SortField** as campaign type and then you can use one of below sorting fields <img width="1118" alt="Screen Shot 1402-01-07 at 12 26 50" src="https://user-images.githubusercontent.com/9850545/227893144-e5455281-b2b3-4cfa-8d8e-e61f7dfd78a8.png">

* `FilterFields`: Sometimes we need to filter some projects in a campaign, for instance **Let's verified projects that accept funds on Gnosis chain**, for this we can Add `verified` and `acceptFundOnGnosis` filters <img width="1108" alt="Screen Shot 1402-01-07 at 12 40 50" src="https://user-images.githubusercontent.com/9850545/227896978-f5820a20-5727-42c3-a209-9d43b1ede865.png">
* `FilterFields`: Sometimes we need to filter some projects in a campaign, for instance **Show verified projects that accept funds on Gnosis chain**, for this we can Add `verified` and `acceptFundOnGnosis` filters <img width="1108" alt="Screen Shot 1402-01-07 at 12 40 50" src="https://user-images.githubusercontent.com/9850545/227896978-f5820a20-5727-42c3-a209-9d43b1ede865.png">

* `WithoutProjects`: Some campaigns don't include any project in them and they are just some banner like **Feeling $nice?** campaign in below image <img width="1367" alt="Screen Shot 1402-01-07 at 12 43 48" src="https://user-images.githubusercontent.com/9850545/227897739-5de5fba1-d1ab-47da-849c-7c02c1909884.png">

Expand All @@ -21,8 +21,8 @@
* `Related Projects Slugs` : It's just **Required** for campaigns with type `ManuallySelected`, I already explained it above in **type** section
* `Photo`: **Optional**, This is the image link that we show in campaign banner, first you need to upload image in pinata and use that link in here, for instance for below campaign this is the value of photo https://giveth.mypinata.cloud/ipfs/QmYR3KLnsRKiibuS5oBRLnyaLM7Sv1QcbBEAPN1DD6d7UP/Nice%20token@2x.png <img width="1405" alt="Screen Shot 1402-01-07 at 13 00 39" src="https://user-images.githubusercontent.com/9850545/227902144-f16b6575-b875-4895-a1e7-f5a235e57e27.png">
* `Video`:**Optional**, Some campaigns use video instead of image in banner, like photo first we need to upload it somewhere and then put it here, campaign example <img width="1396" alt="Screen Shot 1402-01-07 at 13 08 27" src="https://user-images.githubusercontent.com/9850545/227904246-1301b526-41ba-4ec7-85ac-9218a1056402.png">
* `Video Preview`:**Optional**, There is an image like above one that we show for video before playing, so if you fill `Video` it's required to put an image link here to show that as vodeo's preview
* ‍`Order`: If you want to show a campaign before others please fill order for it ( we show 1 after that 2, ..) and after those campaigns we show campaigns without orders sorted by created date descanding
* `Landing Link`: **Optional**, Sometime we want to redirect user to an external link when click on **Exlore** in campaign card, it happens for campaigns that have **WithoutProject** type because other campaigns usually redirect user to a project list page, in case of you want to redirect to an external link, please fill this field
* `Video Preview`:**Optional**, There is an image like above one that we show for video before playing, so if you fill `Video` it's required to put an image link here to show that as video's preview
* ‍`Order`: If you want to show a campaign before others please fill order for it ( we show 1 after that 2, ..) and after those campaigns we show campaigns without orders sorted by created date descending
* `Landing Link`: **Optional**, Sometime we want to redirect user to an external link when click on **Explore** in campaign card, it happens for campaigns that have **WithoutProject** type because other campaigns usually redirect user to a project list page, in case of you want to redirect to an external link, please fill this field
* `Filter Fields`: It's just **Required** for campaigns with type `FilterFields`, I already explained it above in **type** section
* `Sorting Field`: It's just **Required** for campaigns with type `SortField`, I already explained it above in **type** section