Files

71 lines
3.0 KiB
TypeScript
Raw Permalink Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
import Link from 'next/link'
import { Page, PageHero, Prose, Section } from '@/components/marketing/page-kit'
import { pageMeta } from '@/lib/page-meta'
import HanzoOpenSourceShowcase from '@/components/oss/HanzoOpenSourceShowcase'
/**
* The open-source royalty, as hanzoai/cloud apps/author pays it: `defaultShareBps`
* 2000 of a deploying org's metered spend, per period, to the verified author of
* the repository the deployed project was built from.
*/
const SHARE = '20%'
export const metadata = pageMeta({
title: 'Open source royalty',
description: `A verified author earns ${SHARE} of the metered spend of every org that deploys a project built from their repository.`,
path: '/oss',
})
export default function Oss() {
return (
<Page>
<PageHero
eyebrow="Open source"
title="Your repository runs, and you are paid"
lede={`Verify that you own a repository. Every org that deploys a project built from it pays you ${SHARE} of its metered spend, accrued each period, with the record behind every number.`}
/>
<Section title="How it works">
<Prose>
<ol>
<li>
Connect your GitHub account with <code>POST /v1/author/connect</code>.
</li>
<li>
Prove you own a repository, or a whole owner, with <code>POST /v1/author/repos/verify</code>: through a
linked GitHub account that can push to it, or a <code>hanzo.json</code> on its default branch carrying
your verify code.
</li>
<li>When an org deploys a project built from that repository, the deploy is recorded against it.</li>
<li>
Each period, you accrue {SHARE} of that org’s metered spend — once per org per period, and never from
your own org.
</li>
<li>Payouts are recorded against what has accrued, and settled by a person.</li>
</ol>
<p>
Repositories Hanzo maintains earn the same {SHARE} when other orgs deploy them, recorded to Hanzo’s own
account.
</p>
</Prose>
</Section>
<Section title="What you can read">
<Prose>
<p>
<code>GET /v1/author</code> answers your verified repositories, the deploys recorded against them, and what
has accrued, is pending and has been paid. <code>GET /v1/author/basis</code> is the audit trail: every
ledger row, the spend it was computed from and the share applied.
</p>
<p>
Referring customers is a separate programme, paid on Hanzo’s margin: see{' '}
<Link href="/affiliate">affiliates</Link>. Everything Hanzo publishes is on{' '}
<Link href="/open-source">the open source page</Link>.
</p>
</Prose>
</Section>
<Section title="Ecosystem activity">
<HanzoOpenSourceShowcase showHero={false} activityOnly embedded />
</Section>
</Page>
)
}