Skip to content

Commit

Permalink
docs: update for independent Polar organization
Browse files Browse the repository at this point in the history
Fix #3673
  • Loading branch information
frankie567 committed Jul 24, 2024
1 parent 9586a16 commit f4b82db
Show file tree
Hide file tree
Showing 132 changed files with 64 additions and 29 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified clients/apps/web/src/app/docs/(mdx)/benefits/benefits.light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified clients/apps/web/src/app/docs/(mdx)/benefits/manage.dark.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/benefits/manage.light.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/donations/enable.dark.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/donations/form.dark.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/donations/form.light.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/donations/github_tip.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/donations/thanks.dark.png
14 changes: 11 additions & 3 deletions clients/apps/web/src/app/docs/(mdx)/github/funding-yaml/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,16 @@ Polar is an official GitHub `FUNDING.yaml` provider. Creating a gorgeous link on
your GitHub repositories to your Polar page for newsletters, donations, issue
funding, subscriptions and products.

<iframe width="560" height="315" src="https://www.youtube.com/embed/nWAci36HdbQ?si=K5Hg7bzeAuh3q8Sk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/nWAci36HdbQ?si=K5Hg7bzeAuh3q8Sk"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
referrerpolicy="strict-origin-when-cross-origin"
allowfullscreen
></iframe>

<a href="https://news.ycombinator.com/item?id=39382281">
<img
Expand All @@ -25,9 +34,8 @@ or...
2. Create or modify `.github/FUNDING.yaml`
3. Add the configuration below


```yaml
polar: YOUR_USER_OR_ORGANIZATION_NAME
polar: YOUR_POLAR_ORGANIZATION_SLUG
```
4. Commit and you're done
Expand Down
40 changes: 25 additions & 15 deletions clients/apps/web/src/app/docs/(mdx)/github/install/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,27 @@ import BrowserCallout from '@/components/Feed/Markdown/Callout/BrowserCallout'

# Connect GitHub organizations

It's super easy to connect additional organizations and their repositories.
Polar is able to integrate with GitHub to sync your repositories and issues, in particular to enable [issue funding](/docs/issue-funding).

1. Click on your profile in the dashboard
2. Click `Add GitHub Organization`
3. You'll be redirected to GitHub to install the Polar GitHub app for desired organizations and repositories
## First installation

![Screenshot of adding GitHub Organization](add-org.light.png)
![Screenshot of adding GitHub Organization](add-org.dark.png)
![Screenshot of choosing GitHub Organization](gh-choose-org.png)
To do so, you can click on `Install GitHub App` on the sidebar.

<BrowserCallout type="NOTE">
**Want to add more repositories to an existing organization?**
![Start GitHub Installation](install-github.light.png)
![Start GitHub Installation](install-github.dark.png)

You can add them in your GitHub App settings for Polar. You can click `Add GitHub Organization` on Polar again and upon choosing the same organization (`Configure`) it will redirect you to that view.
</BrowserCallout>
### Select a GitHub organization

You'll be taken to GitHub where you'll be asked to select the organization you want to install.

![Screenshot of choosing GitHub Organization](gh-choose-org.png)

### Install repositories

![Screenshot of choosing GitHub Installation](gh-install.png)

What does Polar use repository access for?

- You want to enable crowdfunding behind issues
- You want to showcase & promote them on your Polar page
- You want to sell access to Private GitHub Repo(s). However, this feature uses a separate opt-in app installation with additional permissions.
Expand All @@ -32,6 +31,7 @@ What does Polar use repository access for?
**Do I have to install repositories?**

Yes, GitHub's App installation flow requires granting access to at least one (1) repository to work.

</BrowserCallout>

#### All Repositories
Expand All @@ -55,20 +55,19 @@ private repositories to try Polar with.

#### Select Repositories

- You choose *exactly* which repositories Polar should have access to
- You choose _exactly_ which repositories Polar should have access to
- **Pros:** Complete control. Gradual expansion. Great starting point.
- **Cons:** You need to manually add repositories.


<BrowserCallout type="NOTE">
**You can add/remove repositories at any time**

You can change repository access in your GitHub
settings for the Polar app at any time.
</BrowserCallout>

</BrowserCallout>

### Required permissions & usage
#### Required permissions & usage

**Read access to metadata**

Expand All @@ -91,3 +90,14 @@ Polar funding badge directly within selected issues (at the bottom of their
description). We need to be able to write to issues in order to achieve this. Of
course, we only embed the badge based on your settings and desired issues to
badge.

## Manage installation and connect more organizations

You can manage your installed GitHub organizations from `Issues` > `Organizations`.

![Manage GitHub Organizations](manage-github-organizations.light.png)
![Manage GitHub Organizations](manage-github-organizations.dark.png)

Click on `Manage installation` to get back to GitHub and add or remove repositories enabled on Polar.

You can link **more than one** GitHub organization to your Polar organization. To add another, click on `Link new organization`. You'll be taken through the same process described above.
39 changes: 28 additions & 11 deletions clients/apps/web/src/app/docs/(mdx)/onboarding/page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,29 +7,32 @@ import { UserSignupType } from '@polar-sh/sdk'
Let's get you up and running with Polar in only a few minutes.

## Create an account

Signup & login on Polar is made super easy with GitHub Login (OAuth).

<GithubLoginButton
className="text-white mb-8"
size="small"
text="Continue with GitHub"
userSignupType={UserSignupType.MAINTAINER}
returnTo="/maintainer"
/>
<div className="not-prose">
<GithubLoginButton
className="mb-8 text-white"
size="small"
text="Continue with GitHub"
userSignupType={UserSignupType.MAINTAINER}
returnTo="/maintainer"
/>
</div>

- By continuing you agree to our [Terms of Service](/legal/terms) and [Privacy Policy](/legal/privacy)
- You'll be redirected to login with GitHub (next step)

<BrowserCallout type="NOTE">
In the future, we'll support standalone accounts without GitHub too - discussed in [#3608](https://github.com/orgs/polarsource/discussions/3608)
Don't want to connect with GitHub? You can also [sign up using your
email](https://polar.sh/login).
</BrowserCallout>

### Grant GitHub Permissions

Polar uses your GitHub Login to:

- Create a matching, public, profile for you on Polar (avatar, username, bio etc)
- Setup your Polar page: `https://polar.sh/<username>`
- Request read-only access to your primary GitHub email addresses so we can communicate with you, e.g send funding, subscription and order notifications and product updates.

![Screenshot of GitHub OAuth with Polar](./gh-auth.light.jpg)
Expand All @@ -45,9 +48,21 @@ performed by you via Polar for an explicit, clear & desired outcome by you.

</BrowserCallout>

## Onboarding
## Create your organization

Once you've signed up, you'll be taken to a page to create your **organization**. On Polar, an organization is the space where you'll create and manage your products, receive donations from your supporters and more.

The first step is to give it a name.

Once you've signed up, you'll be taken through a quick onboarding page intended to focus the Polar experience for your use case.
![Create Organization on Polar](./create-organization.light.png)
![Create Organization on Polar](./create-organization.dark.png)

<BrowserCallout type="NOTE">
Our system will assign you a unique *slug* (like `unicorn-dev`) that you won't
be able to change. However , you'll be able to change the display name later.
</BrowserCallout>

Then, you'll be taken through a quick onboarding page intended to focus the Polar experience for your use case.

![Screenshot of Polar Onboarding](./onboarding.light.jpg)
![Screenshot of Polar Onboarding](./onboarding.dark.jpg)
Expand All @@ -59,6 +74,7 @@ Once you've signed up, you'll be taken through a quick onboarding page intended
Welcome to the Polar community - we're thrilled to have you onboard!

**Next Steps:**

- Explore the dashboard
- [Connect GitHub organizations (Optional)](/docs/github/install)
- [Add official Polar funding link on GitHub](/docs/github/funding-yaml)
Expand All @@ -68,5 +84,6 @@ Welcome to the Polar community - we're thrilled to have you onboard!
- [Start a newsletter](/docs/newsletters)

**Shape the future with us**

- [Join our Discord](https://discord.gg/BZw96tszTX)
- [Give our GitHub repo a star](https://github.com/polarsource/polar) and join the discussions
Binary file modified clients/apps/web/src/app/docs/(mdx)/products/checkout.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/products/custom.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/products/order.dark.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/products/order.light.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/products/thanks.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/products/tiers.dark.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/products/tiers.light.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/sales/overview.dark.png
Binary file modified clients/apps/web/src/app/docs/(mdx)/sales/overview.light.png

0 comments on commit f4b82db

Please sign in to comment.