POSTED 7 months ago

Getting Started on Kauri



Welcome to the Kauri Rinkeby release! This early version of Kauri is designed to facilitate the creation of tutorials, walkthroughs, and guides for a select group of exciting Ethereum-based projects and libraries. Things you will be able to do include: viewing and tipping (with ETH) articles, searching for content across 10 different projects, requesting new tutorials and attaching (or adding to) a bounty, submitting new articles for approval from project maintainers (e.g. the uPort team), and winning real ETH and tokens in our launch competition! To get started, we recommend installing MetaMask, getting some Rinkeby Ether from the faucet, and creating an account to have full access to all of Kauri's features. That being said, you can access all of the content and project pages on Kauri without signing up!

Creating an Account

Creating an account will allow you to tip articles, request new content, and earn ETH by writing articles.

  1. Navigate to: https://rinkeby.kauri.io/login
  2. Set MetaMask to the “Rinkeby” network
  3. Enter email (will be kept private, used for notifications) and username (will be publicly associated with your ETH address)
  4. After hitting submit, click “Sign” on the MetaMask popup to complete the signup process (note: this is not a transaction, and will not cost you any ETH)

Viewing Content

The core of Kauri is the content created by the Ethereum community and projects. View all available topics on the homepage (also available in list form by selecting “Topics” from the navigation bar), and see the latest articles and requests. Select the “uPort” topic to be taken to our page, where you can view all articles and requests related to using uPort.
Click on an article to read it, and if you enjoy the article and want to reward the author, you can send them a tip in Ether!

If you aren't sure where to find a particular subject, use the full-content search in the navbar, and go directly to any articles that match.


Requesting New Content

Is something missing? Maybe a tutorial on using the latest uPort Javascript SDK in React? Ask for it, and the community will deliver! You can attach an ETH bounty to your request (for faster responses), or not (maybe someone else, or the team themselves, will!).

Responding to a Request

Want to help out your favorite project, get noticed, and earn some ETH? Respond to a request and write an article! You also have the option to submit an article on it's own, get feedback from the project maintainers themselves, and be eligible for tips. If you see something you'd like to work on in the “Requests” tab, click on the title to learn more, and clear up any outstanding questions.
Once you have the information you need to get started, you can click “I'm on it”. Clicking this will trigger a transaction, locking the request until the deadline and signifying to everyone that someone is working on the request. This is entirely optional, as you have the option to forgo the locking and just start writing.

Writing an Article

Below is an illustration of the process for submitting an article, then having it approved and published.


When you are satisfied with the state of your article, selecting “submit for review” will start the revision process. At this time, your article will become visible to your topic's moderators (the uPort team, for example), who will be able to comment on your article. You will be able to view and respond to comments, as well as make changes by selecting “Update”.
Note: Comments will only be shown for the current version of the article, meaning once you update the article, comments will disappear until moderators add more. Once the moderators are satisfied with your article, they will “Approve” it. At this point, you must “Submit for Publishing”, which will then allow the moderators to publish your article, and award you the bounty! The reason for this process is to ensure both parties (the author and the moderators) know the content they are agreeing to joint publish. The “Approve” transaction adds a hash of the content to the smart contract from the moderator's side. The “Submit for Publication” transaction does the same for the author. Then in the final “Publish” transaction, the two hashes to ensure they are the same, awards the bounty to the author, changes the article status to “published”, and closes the bounty. Note: If you're responding to a request with an associated mainnet bounty on bounties.network (link will be included in the original request), make sure to claim your reward!

To do so:

  1. Click on the bounties link in the original request
  2. Switch MetaMask to “Main Ethereum Network”
  3. Select “Fulfill the Bounty”
  4. Enter the same username and email used for your Kauri account
  5. Include the link to your approved and published article on Kauri in the “Submission Description and Comments” (e.g. https://rinkeby.kauri.io/article/cfc2f6f13cca4b73a52d36b52c79d687)
  6. Click “Submit”, sign the transaction using MetaMask, and wait to receive your reward!

Writing a standalone article This is essentially the same as responding to a request (minus the immediate reward, but with tips!), with exactly the same approval process.


Managing Your Profile

This is the home for all of your interactions of Kauri. View the status of any requests or articles you've created, and withdraw any ETH you've earned on Kauri! Here you can:

  1. Withdraw any funds earned through bounties or tips
  2. View all created requests, and see their status
  3. View all created articles, and their statuses

Questions?

If you can't find something, or have any feedback, suggestions, comments, or critiques, please reach out! You can find us at help@kauri.io, on Twitter, or on the Gitcoin Slack in #kauri-general.
OWNER
Kauri