Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
rossbulat committed Sep 18, 2024
2 parents db655cd + 171e4b6 commit fd6c71e
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 6 deletions.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
This is a [Vocs](https://vocs.dev) project bootstrapped with the Vocs CLI.

# Overview

Welcome to the Polkadot.Cloud documentation! This section provides comprehensive guides and information for using and contributing to Polkadot.Cloud. Whether you're a developer, a staker, or a contributor, you'll find everything you need to get started and make the most out of Polkadot.Cloud.
2 changes: 1 addition & 1 deletion docs/pages/console/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The Developer Console documentation is split into three sections, categorised ba

## About Polkadot Developer Console

Polkadot Developer Console is a next-generation developer tool for the Polkadot ecosystem. A Public Alpha version was [annonced](https://x.com/rossbulat/status/1825967285896380659) in August 2024, and is now live at [console.polkadot.cloud](https://console.polkadot.cloud). The codebase is open sourced [on Github](https://github.com/polkadot-cloud/polkadot-developer-console).
Polkadot Developer Console is a next-generation developer tool for the Polkadot ecosystem. A Public Alpha version was [announced](https://x.com/rossbulat/status/1825967285896380659) in August 2024, and is now live at [console.polkadot.cloud](https://console.polkadot.cloud). The codebase is open sourced [on Github](https://github.com/polkadot-cloud/polkadot-developer-console).

Developer Console has studied and identified issues and shortfalls of [Polkadot JS Apps](https://polkadot.js.org/apps), and aims to take strides in improving the usability, usefulness, and developer documentation (and therefore, maintenance and growth) of the codebase.

Expand Down
36 changes: 32 additions & 4 deletions docs/pages/contributing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,49 @@ import { Callout } from 'vocs/components'

## Overview

Contribute code to Polkadot Cloud Applications and get tipped in DOT or USDT for your work. The Polkadot Cloud Contribution Program utilises the OpenGov treasury to disberse tips to contributors.
Contribute code to Polkadot Cloud Applications and get tipped in DOT or USDT for your work. The Polkadot Cloud Contribution Program utilises the OpenGov treasury to disburse tips to contributors.

With the Contribution Program you can expect:

* __Mentorship__: Polkadot Cloud will provide mentorship to help you complete your tip.
* __Guaranteed Backing__: For every completed tip, Polkadot Cloud will automatically give __50,000 DOT Aye conviction__.
* __Full transparency__: The tip amount will be decided by the Polkadot Cloud team based on the complexity of the task prior to works starting.
* __DOT or USDT__: The tip currency will be applied bassed of your choosing.
* __DOT or USDT__: The tip currency will be applied based on your choosing.
* __Improved GitHub Portfolio__: Boost your GitHub history and CV by contributing to Polkadot Cloud Applications. Work on real-world problems to improve application-side Web3.

Upon completing a tip, Polkadot Cloud will open an OpenGov proposal on your behalf and disburse the tip amount upon the referendum successfully passing.

<Callout type="warning"> OepnGov tips require a 28 day voting period whereby at least a 50% Aye conviction is needed to pass. Although tips are not guaranteed, Polkadot Cloud will maximise the chances of your tip passing by providing rationale for the tip and ensuring the tip is well documented.</Callout>
<Callout type="warning"> OpenGov tips require a 28 day voting period whereby at least a 50% Aye conviction is needed to pass. Although tips are not guaranteed, Polkadot Cloud will maximise the chances of your tip passing by providing rationale for the tip and ensuring the tip is well documented.</Callout>

## Getting Sarted
## Eligibility

To be eligible for a tip, contributors must:

* Resolve an eligible Issue on GitHub with a merged Pull Request (PR).
* Address issues marked with the "Active Tip" label.
* Meet quality standards set by the Polkadot Cloud team.
* Complete the task within the specified time frame.
* Be in good standing with the community (no history of malicious behavior or consistent non-delivery).

## Discovering New Tips

We cannot document every bug, issue and idea to grow our apps. Therefore, we promote users raising their own issues, which could then be used as new tips.

Process for user-discovered tips:
* User posts an Issue or Discussion on Github describing what works they want done. Could use a label "Tip Request".
* We then review, and if eligible, we will assign the label to the Issue and update the project board.
* If the user wants to work on the issue themself, they will immediately be assigned. If not, wait until an assignee expresses interest.

## Tip Logistics

### Badges and Recognition
* Participating repositories will display a badge in their README files promoting the Polkadot Cloud Pioneers program.
* An infographic or short paragraph in READMEs will provide additional visibility for the program.

### Time Limits and Accountability
* Default time limit: 30 days from assignment to completion.

## Getting Started

Coming soon...

Expand Down

0 comments on commit fd6c71e

Please sign in to comment.