Merge pull request #81 from gosh-sh/hackathons

Added a description of Hackathons
gosh-sh · Nov 28, 2023 · e0b93d7 · e0b93d7
2 parents a2a4091 + 26444ef
commit e0b93d7
Show file tree

Hide file tree

Showing 170 changed files with 7,316 additions and 198 deletions.
diff --git a/docs/anytree-all.md b/docs/anytree-all.md
@@ -85,7 +85,7 @@ or use quick start.
     * Docker
     * Python3 with pip (required to generate a `SBOM-file`)
 
-    To create artifacts, you will need an `SBOM file` created  according to the [Cyclone DX specification](https://cyclones.org/docs/1.5/json/)
+    To create artifacts, you will need an `SBOM file` created  according to the [Cyclone DX specification](https://cyclonedx.org/docs/1.5/json/)
 
     !!! info
         The example file can be viewed here:  
@@ -187,7 +187,7 @@ Prerequisites:
     * Docker
     * Python3 with pip (required to generate a `SBOM-file`)
 
-    To create artifacts, you will need an `SBOM file` created  according to the [Cyclone DX specification](https://cyclones.org/docs/1.5/json/)
+    To create artifacts, you will need an `SBOM file` created  according to the [Cyclone DX specification](https://cyclonedx.org/docs/1.5/json/)
 
     !!! info
         The example file can be viewed here:  

diff --git a/docs/hacks-and-grants/overview.md b/docs/hacks-and-grants/overview.md
@@ -0,0 +1,14 @@
+# **Overview**
+
+
+The **"Hacks & Grants"** is the new tool integrated into [**DAOs**](../on-chain-architecture/organizations-gosh-dao-and-smv.md#dao) on **GOSH** which allows any DAO to create its own [**Hackathon**](user-guide.md#hackathon) or [**Grant Program**](user-guide.md#grant-program) of any size directly from their decentralized repository
+
+<!-- TODO open after implementation -->
+<!-- Hacks & Grants include an automated reward system, allowing users to  tailor their Hacks & Grants program to include any format, be it dollars, euros, pound sterling, Bitcoin, Ether, ERC-20, or DAO tokens. Users can also bring different sponsors to their Hackathon, and the Hacks & Grant program supports multi-token reward pools -->
+
+Hacks & Grants will soon include an automated reward system that allows users to adapt their Hacks & Grants program to any format, be it dollars, euros, pounds, bitcoins, ether, ERC-20 or DAO tokens(*supported*). Users can also invite different sponsors to their Hackathon. Planned in the Hacks & Grant program supports multi-token reward pools
+
+All code, files, and results stored in decentralized open source code repositories, meaning all Hackathon rules are automatically enforced on-chain, and in a trustless environment
+
+Grants on GOSH allow collaborative problem-solving events to be financed, and so sustained, for a longer period of time *(coming soon)*
+
diff --git a/docs/hacks-and-grants/user-guide.md b/docs/hacks-and-grants/user-guide.md
@@ -0,0 +1,254 @@
+# **User Guide**
+
+
+## Hackathon
+
+
+### **for the organizers**
+
+
+To create a **Hackathon**, you need to navigate to the **"Hacks & Grants"** tab in the Dao where you are a member.
+
+Make sure to check the guidelines and requirements of the DAO to ensure that you have the necessary permissions and resources to host the Hackathon.
+
+
+![](../images/H&G_hacks_1_dao_h&g_tab.jpg)
+
+and click **Create new** or start typing the name of the your Hackathon
+
+![](../images/H&G_hacks_2_create_new_name.jpg)
+
+then click **New hackaton**
+
+
+!!! warning "important"
+    * To create a Hackathon, you must be a member of the DAO.
+
+    * The DAO must have enough tokens in its reserve to allocate towards Hackathon rewards.
+
+
+
+**On the page that opens, enter all the necessary  information about the event:**
+
+
+* In the **README** section tell the about your program. What are its aims? Who should participate? How will it work?
+
+![](../images/H&G_hacks_3_readme.jpg)
+
+
+
+* In the **RULES** section, describe the rules that the participants should follow. What is expected, allowed and strictly prohibited?
+
+![](../images/H&G_hacks_5_rulles.jpg)
+
+* In the **PRIZES** section, it is important to outline of the awards will be distributed among the participants. Additionally, it is crucial to explain the evaluation criteria used to determine the winners.
+
+Also here you have the opportunity to provide detailed information about any additional prizes that will be available to participants. This can be a great way to encourage engagement and encourage people to participate in your event or program.
+
+<!-- TODO when will the opportunity be supported in dollars -->
+<!-- ![](../images/H&G_hacks_6_prizes.jpg) -->
+
+![](../images/H&G_hacks_6_prizes_dao-tokens.jpg)
+
+
+
+!!! info
+    It is not mandatory to provide information in the README, RULES, and PRICES sections, but including them can greatly improve the clarity and informativeness of your content. Therefore, we recommend filling them out whenever possible.
+
+
+
+
+
+* Also, the information about the awards must be configured in the **Prize pool** section by clicking on the **"Add prize pool"** button.
+
+![](../images/H&G_hacks_7_pool_prizes.jpg)
+
+Enter the total amount of the prize pool and distribute it among the prize places.
+
+Then click **Save distribution**
+
+!!! warning
+    The total amount of the prize fund cannot exceed the amount of the DAO reserve balance.
+
+
+<!-- TODO when will the opportunity be supported in dollars... -->
+
+![](../images/H&G_hacks_8_setup_prize_pool.jpg)
+
+<!-- !!! info
+    Until the prize fund is put up, the Hackathon will be in the Draft status -->
+
+To make any changes, simply click on the "Update prize pool" button.
+
+![](../images/H&G_hacks_9_update_prize_pool.jpg)
+
+
+
+
+* Don't forget to fill in the **Short Description** section. This information will be visible in the proposal for voting on the creation of the Hackathon after all the necessary data has been filled about the event.
+
+![](../images/H&G_hacks_4_shot_description.jpg)
+
+
+
+
+
+* You will need to set the date and time for three important stages.  
+Do this by clicking on the **Add date** button
+
+![](../images/H&G_hacks_10_time.jpg)
+
+and in the window that opens, configure on 3 tabs:
+
+**Start** tab - here you need to set the start date and time of the Hackathon.
+
+
+**Voting** tab - here you need to set the date and time when the acceptance of applications ends, and when they will be presented to the jury members for voting.
+
+
+!!! warning
+    After the start of the voting stage, it will be impossible to add new participants.
+
+
+**Finish** tab - you need to set the date and time when the voting stage ends and the winners will be determined.  
+Then click **Apply dates**
+
+![](../images/H&G_hacks_11_time_set.jpg)
+
+Once you've set the dates and times, you can click on **Create proposal to publish**
+
+![](../images/H&G_hacks_12_create_proposal_to_publish.jpg)
+
+
+
+The preparation of the Hackathon repository and the creation of a proposal for its creation will begin.
+
+And once it's done, you will be redirected to the DAO events page. 
+
+![](../images/H&G_hacks_13_proposal.jpg)
+
+Once the voting process is completed with a positive outcome, a Hackathon will be created.
+
+![](../images/H&G_hacks_14_hacks_created.jpg)
+
+!!! warning "important"
+    **After the Hackathon is created, its data can be changed and any alterations are subject to voting for approval.**
+
+
+![](../images/H&G_hacks_15_edit.jpg)
+<!-- 
+![](../images/H&G_hacks_15_4.jpg)
+![](../images/H&G_hacks_15_3.jpg)
+![](../images/H&G_hacks_15_2_edit.jpg)
+ -->
+
+To be aware of the status of the Hackathon, the time remaining until the next stage will be displayed on its page.
+
+![](../images/H&G_hacks_22_time_to_voting_stage.jpg)
+
+When the application acceptance stage comes to an end, the **`Voting`** stage will begin.
+
+![](../images/H&G_hacks_23_time_to_finish_stage.jpg)
+
+
+At the end of the **`Voting`** stage, the summing up will start, and the Hackathon will be marked as **`Finished`**
+
+![](../images/H&G_hacks_24_finish_stage.jpg)
+
+
+
+
+
+
+
+
+### **for participants**
+
+**If you're a GOSH user** who is interested in participating in a Hackathon, you'll need to visit the Hackathon organizer's DAO. Once there, you can navigate to the **"Hacks and Grants"** tab to learn more about the available Hackathons and select the one that interests you.
+
+On the Hackathon page you will find all the necessary information, including a detailed description of the Hackathon, its rules and prizes that can be obtained.
+
+
+**If you're not a GOSH user** but want to participate in the Hackathon, you'll need to [**create an GOSH account**](../working-with-gosh/gosh-web.md#create-account) first.  
+Then you can visit the Hackathon page to get started.
+
+During the Hackathon, all participants must complete certain tasks and then upload them to their [repositories](../working-with-gosh/gosh-web.md#working-with-repository) into their [DAO](../working-with-gosh/gosh-web.md#create-organization-dao).
+
+To participate in the Нackathon, you'll need to click on the **Add application** button.
+
+![](../images/H&G_hacks_16_for_partic_add_aplic.jpg)
+
+
+!!! info "If you followed the direct link to the Hackathon"  
+
+    then be sure to log into your account by clicking on the **Sign in** button.  
+
+    <!-- ![Image title](../images/H&G_hacks_17_sign_in_.jpg){ align=right } -->
+    ![](../images/H&G_hacks_17_sign_in_.jpg)
+
+    After you entered your passphrase and PIN code on the Hackathon page, the next step is to click on the **Add application** button.
+    { .ml-params }
+
+<!-- ![](../images/H&G_hacks_18_add_1.jpg) -->
+
+
+Then, in the form that opens, click **Add application form DAO**
+
+![](../images/H&G_hacks_18_add_2.jpg)
+
+and enter the name of your DAO and the names of the repository that you require.
+
+
+
+!!! warning "Important"
+
+    * You can **add an application** **only** from the **DAO** of which you are a **member**.
+
+    * Also, keep in mind that **each repository** is a **separate participant** of the Hackathon.
+
+
+
+
+
+!!! info
+    You can add multiple repositories from one DAO at once by separating the input with a space.
+
+<!-- Do this for all the DAOs you need to participate in the Hackathon, and then click ** Submit applications** -->
+
+Once you have added all the necessary applications, click on "Submit applications".
+
+
+![](../images/H&G_hacks_19_add_DAO_repos.jpg)
+
+
+
+
+At the end of the process, all the repositories you have uploaded will be displayed in the "Your applications" section.  
+
+![](../images/H&G_hacks_20_your_applics.jpg)
+
+Additionally, you can view information about the other participants of the Hackathon in the "Participants" section.
+
+![](../images/H&G_hacks_21_all_partica.jpg)
+
+
+<!-- The remaining time until the next stage will be displayed on the Hackathon page, allowing participants to stay updated on the status of the competition. -->
+
+To keep participants updated on the status of the competition, the remaining time until the next stage will be displayed on the Hackathon page.
+
+![](../images/H&G_hacks_22_time_to_voting_stage.jpg)
+
+When the application acceptance stage comes to an end, the **`Voting`** stage will begin.
+
+![](../images/H&G_hacks_23_time_to_finish_stage.jpg)
+
+
+At the end of the **`Voting`** stage, the summing up will start, and the Hackathon will be marked as **`Finished`**
+
+![](../images/H&G_hacks_24_finish_stage.jpg)
+
+
+
+## Grant Program
+
+*coming soon*
diff --git a/docs/images/H&G_hacks_10_time.jpg b/docs/images/H&G_hacks_10_time.jpg
diff --git a/docs/images/H&G_hacks_11_time_set.jpg b/docs/images/H&G_hacks_11_time_set.jpg
diff --git a/docs/images/H&G_hacks_12_create_proposal_to_publish.jpg b/docs/images/H&G_hacks_12_create_proposal_to_publish.jpg
diff --git a/docs/images/H&G_hacks_13_proposal.jpg b/docs/images/H&G_hacks_13_proposal.jpg
diff --git a/docs/images/H&G_hacks_14_hacks_created.jpg b/docs/images/H&G_hacks_14_hacks_created.jpg
diff --git a/docs/images/H&G_hacks_15_2_edit.jpg b/docs/images/H&G_hacks_15_2_edit.jpg
diff --git a/docs/images/H&G_hacks_15_3.jpg b/docs/images/H&G_hacks_15_3.jpg
diff --git a/docs/images/H&G_hacks_15_4.jpg b/docs/images/H&G_hacks_15_4.jpg
diff --git a/docs/images/H&G_hacks_15_edit.jpg b/docs/images/H&G_hacks_15_edit.jpg
diff --git a/docs/images/H&G_hacks_15_edit_dop.jpg b/docs/images/H&G_hacks_15_edit_dop.jpg
diff --git a/docs/images/H&G_hacks_16_for_partic_add_aplic.jpg b/docs/images/H&G_hacks_16_for_partic_add_aplic.jpg
diff --git a/docs/images/H&G_hacks_16_for_partic_add_aplic2.jpg b/docs/images/H&G_hacks_16_for_partic_add_aplic2.jpg
diff --git a/docs/images/H&G_hacks_17_sign_in_.jpg b/docs/images/H&G_hacks_17_sign_in_.jpg
diff --git a/docs/images/H&G_hacks_18_add_1.jpg b/docs/images/H&G_hacks_18_add_1.jpg
diff --git a/docs/images/H&G_hacks_18_add_2.jpg b/docs/images/H&G_hacks_18_add_2.jpg
diff --git a/docs/images/H&G_hacks_19_add_DAO_repos.jpg b/docs/images/H&G_hacks_19_add_DAO_repos.jpg
diff --git a/docs/images/H&G_hacks_1_dao_h&g_tab.jpg b/docs/images/H&G_hacks_1_dao_h&g_tab.jpg
diff --git a/docs/images/H&G_hacks_20_your_applics.jpg b/docs/images/H&G_hacks_20_your_applics.jpg
diff --git a/docs/images/H&G_hacks_21_all_partica.jpg b/docs/images/H&G_hacks_21_all_partica.jpg
diff --git a/docs/images/H&G_hacks_22_time_to_voting_stage.jpg b/docs/images/H&G_hacks_22_time_to_voting_stage.jpg
diff --git a/docs/images/H&G_hacks_23_time_to_finish_stage.jpg b/docs/images/H&G_hacks_23_time_to_finish_stage.jpg
diff --git a/docs/images/H&G_hacks_24_finish_stage.jpg b/docs/images/H&G_hacks_24_finish_stage.jpg
diff --git a/docs/images/H&G_hacks_2_create_new_name.jpg b/docs/images/H&G_hacks_2_create_new_name.jpg
diff --git a/docs/images/H&G_hacks_3_readme.jpg b/docs/images/H&G_hacks_3_readme.jpg
diff --git a/docs/images/H&G_hacks_4_shot_description.jpg b/docs/images/H&G_hacks_4_shot_description.jpg
diff --git a/docs/images/H&G_hacks_5_rulles.jpg b/docs/images/H&G_hacks_5_rulles.jpg
diff --git a/docs/images/H&G_hacks_6_prizes.jpg b/docs/images/H&G_hacks_6_prizes.jpg
diff --git a/docs/images/H&G_hacks_6_prizes_dao-tokens.jpg b/docs/images/H&G_hacks_6_prizes_dao-tokens.jpg
diff --git a/docs/images/H&G_hacks_7_pool_prizes.jpg b/docs/images/H&G_hacks_7_pool_prizes.jpg
diff --git a/docs/images/H&G_hacks_8_setup_prize_pool.jpg b/docs/images/H&G_hacks_8_setup_prize_pool.jpg
diff --git a/docs/images/H&G_hacks_9_update_prize_pool.jpg b/docs/images/H&G_hacks_9_update_prize_pool.jpg
diff --git a/docs/images/dop1.jpg b/docs/images/dop1.jpg
diff --git a/docs/images/dop2.jpg b/docs/images/dop2.jpg
diff --git a/docs/images/dop3.jpg b/docs/images/dop3.jpg
diff --git a/docs/images/dop4-obsh.jpg b/docs/images/dop4-obsh.jpg
diff --git a/docs/images/dop5.jpg b/docs/images/dop5.jpg
diff --git a/docs/images/dop6.jpg b/docs/images/dop6.jpg
diff --git a/docs/images/dop7.jpg b/docs/images/dop7.jpg
diff --git a/docs/images/dop8.jpg b/docs/images/dop8.jpg
diff --git a/docs/images/dop9.jpg b/docs/images/dop9.jpg
diff --git a/docs/images/dop_membership1.jpg b/docs/images/dop_membership1.jpg
diff --git a/docs/images/dop_membership2.jpg b/docs/images/dop_membership2.jpg
diff --git a/docs/images/dop_membership3.jpg b/docs/images/dop_membership3.jpg
diff --git a/docs/images/dop_membership4.jpg b/docs/images/dop_membership4.jpg
diff --git a/docs/images/dop_membership5.jpg b/docs/images/dop_membership5.jpg
diff --git a/docs/images/dop_membership6.jpg b/docs/images/dop_membership6.jpg
diff --git a/docs/images/dop_membership7.jpg b/docs/images/dop_membership7.jpg
diff --git a/docs/images/dop_membership8.jpg b/docs/images/dop_membership8.jpg
diff --git a/docs/images/dop_membership9.jpg b/docs/images/dop_membership9.jpg
diff --git a/docs/images/ethereum_usage_balance_1.jpg b/docs/images/ethereum_usage_balance_1.jpg
diff --git a/docs/images/ethereum_usage_balance_2.jpg b/docs/images/ethereum_usage_balance_2.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_10_confirm.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_10_confirm.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_11_receive_tokens.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_11_receive_tokens.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_12_completed.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_12_completed.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_1_from.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_1_from.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_2_accounts.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_2_accounts.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_3_from_sum.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_3_from_sum.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_4_to.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_4_to.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_5_summary.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_5_summary.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_6_aprove_tokems.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_6_aprove_tokems.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_7_spending_cap.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_7_spending_cap.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_8_approve.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_8_approve.jpg
diff --git a/docs/images/ethereum_usage_transfer_usdc-to-gosh_9_deposit_tokens_elock.jpg b/docs/images/ethereum_usage_transfer_usdc-to-gosh_9_deposit_tokens_elock.jpg
diff --git a/docs/images/ethereum_usage_withdraw_usdc_1-2_usdc-gosh.jpg b/docs/images/ethereum_usage_withdraw_usdc_1-2_usdc-gosh.jpg
diff --git a/docs/images/ethereum_usage_withdraw_usdc_1_connection_metamask.jpg b/docs/images/ethereum_usage_withdraw_usdc_1_connection_metamask.jpg
diff --git a/docs/images/ethereum_usage_withdraw_usdc_2_accounts.jpg b/docs/images/ethereum_usage_withdraw_usdc_2_accounts.jpg
diff --git a/docs/images/ethereum_usage_withdraw_usdc_3_from.jpg b/docs/images/ethereum_usage_withdraw_usdc_3_from.jpg
diff --git a/docs/images/ethereum_usage_withdraw_usdc_4_summury.jpg b/docs/images/ethereum_usage_withdraw_usdc_4_summury.jpg
diff --git a/docs/images/ethereum_usage_withdraw_usdc_5_to.jpg b/docs/images/ethereum_usage_withdraw_usdc_5_to.jpg