kauri
logo
Kauri is here for the community to help each other use existing components and protocols more effectively. Kauri becomes more useful as more topics are written about and interconnections between projects are made. Initially we are being careful to only let high quality projects onto kauri to maintain standards and make sure early users are engaging with technology that they can develop with today.
The basic criteria for creating a new topic on kauri are the following:
    There are usable components or protocols publicly live (test or mainnet), which users can utilise in developing or running dapps
    The project has some initial documentation or a read me
    The project has an active community
    The project maintainers are willing to engage in topic moderation*
    Preference, in early stages, given to projects committed to OpenSource *A note on moderation: We are exploring ways to make moderation less rigid by building in mechanisms like curation markets. In our first iteration all topic need one or several moderators from the project maintainers.
    Fill in the request form on kauri.io [link], see questions below for reference
    Await approval assuming the request has fulfilled the criteria above
    Create and customize topic page and select initial content to post to kauri
    Onboard moderator(s), need at least one moderator from core team and sign off on all moderators from core team
    Topic/Project Name
    URL
    Project Type
    Description
    Status (Is the project live or available for use)
    URLs of documentation, tutorials, guides
    Estimated number of users
    Ability of project maintainers to moderate
    Knowledge available to be published to kauri at first
    Project colors and logo
logo
The first Rinkeby version of Kauri uses URL addresses to display images in articles and tutorials. Future versions of Kauri will support images uploaded directly to Kauri, via IPFS store.
If you are using an image already on the internet, and have the URL, skip to "Add image to Kauri" section.
There are several options for uploading images to the internet, including imgur.com, imgsafe.org or tus.io. In this article we will use imgur.com as an example.
Navigate to https://imgur.com/upload and sign in or create an account if required. Click the browse button to search for an image or screenshot on your computer.
Select the correct file and hit open.
Navigate to the image in your images and copy the direct link. REMINDER copy direct link, image link will not display correctly.
The direct link from imgur.com will end in .png
Now that you have the URL for the image, you can add the image to a Kauri article!
Right click on any image and click Copy Image Address to copy the URL address to your clipboard.
Adding an image to Kauri is simple once you have a URL address. Click into the article editor and hit the + sign to the left hand side, a few insert options will then be displayed.
Select the image icon and past in the URL when prompted. Like magic the image will insert! If the image is not displaying, remember to get the direct link from imgur or equivalent (ending in .png or another file name extension).
Feel free to give the image a title/description and attribe credit to the image creator or rights holder if applicable.
You can also add in YouTube videos and MP4s through their URL address by selecting the applicable insert icon!
logo
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 will allow you to tip articles, request new content, and earn ETH by writing articles.
    Navigate to: https://rinkeby.kauri.io/login
    Set MetaMask to the “Rinkeby” network
    Enter email (will be kept private, used for notifications) and username (will be publicly associated with your ETH address)
    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)
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.
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!).
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.
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:
    Click on the bounties link in the original request
    Switch MetaMask to “Main Ethereum Network”
    Select “Fulfill the Bounty”
    Enter the same username and email used for your Kauri account
    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)
    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.
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:
    Withdraw any funds earned through bounties or tips
    View all created requests, and see their status
    View all created articles, and their statuses
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.
logo
Before we can set up your team and project on Kauri, we'll need the following information:
    List of email addresses, Rinkeby ETH addresses (both required) of your desired moderators
    Logo image, URL, and desired colors for your project’s page on Kauri
    Which license (if any) you would like your content to be listed under
    We have chosen to default to CC-BY-SA 4.0 for user submitted content through Kauri. This is the default for StackOverflow and Wikipedia, and Wikimedia default to a previous version of this license. CC-BY-SA 4.0 is also one way compatible with GPL v3 If you are dual posting knowledge content on kauri, we can store the original license in the content metadata in IPFS. Please let us know if you have already licensed your content or would like to under a specific license.
    Relevant link: https://choosealicense.com/non-software/ Github identifies CC-BY-SA 4.0 (our default) as an open license for documentation or knowledge content. https://choosealicense.com/ GPL v3, MIT, Apache 2 are also common licenses for documentation but we have no limitations, any license can be stored in the content metadata
Creating an account will allow you to tip articles, request new content, and earn ETH by writing articles.
    Navigate to: https://rinkeby.kauri.io/login
    Set MetaMask to the “Rinkeby” network
    Enter email (will be kept private, used for notifications) and username (will be publicly associated with your ETH address)
    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)
To start using Kauri, we recommend beginning with our Getting Started on Kauri guide.
If you'd like to reward your community with real ETH or tokens for their hard work (which we recommend!) while Kauri is on the testnet, you can do so through our partner bounties.network. StandardBounties is a fully-audited and tested contract on mainnet that supports bounties in ETH or ERC20 tokens.
Creating a bounty on bounties.network is simple.
    Navigate to https://beta.bounties.network/newBounty/
    Switch MetaMask to “Main Ethereum Network”
    Enter a title, include “[Kauri Competition]” at the end e.g. “Attestations in uPort with React.js [Kauri Competition]”
    Use the following description template:
Note:
The bounty amounts on Kauri and bounties.network do not have to match, as bounties on Kauri are using Rinkeby ETH for now
    Select the same bounty deadline as your desired Kauri deadline
    Select “When to Activate”. We recommend “Now”
    When ready, click “Create”
    Create a corresponding bounty on Kauri (same title and description), including the link to your mainnet bounty from bounties.network!
To create a new request for content, click on the “Create Request” button on the right side of the navigation bar.
You can choose any topic (though we recommend yours!), and from several categories (Tutorial, Walkthrough, etc.). We recommend being as descriptive as possible about the content you'd like to see, as well as including details of the acceptance criteria (if applicable). Next, choose a deadline. Keep in mind you need to leave time for several stages of review, and avoid short deadlines when possible. Finally, select the bounty reward in ETH. For this, we recommend reviewing the amounts suggested in other requests.Once you're satisfied with your request, click “Submit Request”. You will be asked by MetaMask for a signature, and then to sign and complete a transaction (submitting the bounty amount to our smart contract).
Using Kauri as a moderator, you will have an additional tab in the top left navigation bar as “Approvals”. From here, you can view all requests created for your topic, see any submissions to these requests, comment on them, approve them, publish them, and reject them. You can also manage all articles submitted directly (without an associated request).
Each request will have the submitted articles listed just below. Click on an article title to view it.
If you think something can be improved, highlight it, and select “comment”. This will open a comment box across from the highlighted section. Comments will be sent and shown to the author, who can respond inline, or update the article to reflect the requested changes.
Note:
Comments are tied to a version of the article, so if the author makes changes, your comments will disappear.
When you are satisfied with the content, select “Approve”. This will initiate a transaction, locking the content hash into the smart contract for later comparison (to ensure the final published content is the same as the content you've just approved). The author will then be directed to “Finalize” the article (with a transaction), at which point you will be able to “Publish” the article, releasing any associated bounty to the author, and publishing the article to your project page! After an article is published, users can search for it, view, and tip it. Tipping is a great way to build a relationship with an active content contributor.
If you'd like to add an article yourself, simply select “Write Article”. Once happy with the content, click “Submit for Review”. After clicking through the confirmation page, you'll be redirected to your profile page. In order to publish the article, you can select the link from your profile page, then click “Submit and Accept Finalised Article”. This will initiate and transaction, and your article will be published!
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 the #kauri-general channel.