diff --git a/assets/images/help/sponsors/example-of-open-source-project-dependency.png b/assets/images/help/sponsors/example-of-open-source-project-dependency.png new file mode 100644 index 000000000000..c395f164fc40 Binary files /dev/null and b/assets/images/help/sponsors/example-of-open-source-project-dependency.png differ diff --git a/assets/images/help/sponsors/sponsors-earch-options.png b/assets/images/help/sponsors/sponsors-earch-options.png new file mode 100644 index 000000000000..de92ba3387bb Binary files /dev/null and b/assets/images/help/sponsors/sponsors-earch-options.png differ diff --git a/assets/images/help/sponsors/sponsors-search-options.png b/assets/images/help/sponsors/sponsors-search-options.png new file mode 100644 index 000000000000..de92ba3387bb Binary files /dev/null and b/assets/images/help/sponsors/sponsors-search-options.png differ diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md index ff1404c40dcd..2993bc18007f 100644 --- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md @@ -1200,7 +1200,7 @@ Key | Type | Description {% data reusables.webhooks.sponsorship_short_desc %} -You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". +You can only create a sponsorship webhook on {% data variables.product.prodname_dotcom %}. For more information, see "[Configuring webhooks for events in your sponsored account](/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)". #### Availability diff --git a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md index f92ae3b709b3..e01f878b7d3b 100644 --- a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md @@ -12,7 +12,7 @@ topics: ### About FUNDING files -You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/articles/about-github-sponsors)." +You can configure your sponsor button by editing a _FUNDING.yml_ file in your repository's `.github` folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." You can add one username, package name, or project name per external funding platform and up to four custom URLs. You can add up to four sponsored developers or organizations in {% data variables.product.prodname_sponsors %}. Add each platform on a new line, using the following syntax: @@ -79,5 +79,5 @@ Anyone with admin permissions can enable a sponsor button in a repository. {% data reusables.files.propose_new_file %} ### Further reading -- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors)" +- "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" - "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/github/authenticating-to-github/reviewing-your-security-log.md b/content/github/authenticating-to-github/reviewing-your-security-log.md index 58b68feb074f..96f380f96917 100644 --- a/content/github/authenticating-to-github/reviewing-your-security-log.md +++ b/content/github/authenticating-to-github/reviewing-your-security-log.md @@ -54,7 +54,7 @@ The events listed in your security log are triggered by your actions. Actions ar | [`project`](#project-category-actions) | Contains all activities related to project boards. | [`public_key`](#public_key-category-actions) | Contains all activities related to [your public SSH keys](/articles/adding-a-new-ssh-key-to-your-github-account). | [`repo`](#repo-category-actions) | Contains all activities related to the repositories you own.{% if currentVersion == "free-pro-team@latest" %} -| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +| [`sponsors`](#sponsors-category-actions) | Contains all events related to {% data variables.product.prodname_sponsors %} and sponsor buttons (see "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" and "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} | [`team`](#team-category-actions) | Contains all activities related to teams you are a part of.{% endif %}{% if currentVersion != "github-ae@latest" %} | [`two_factor_authentication`](#two_factor_authentication-category-actions) | Contains all activities related to [two-factor authentication](/articles/securing-your-account-with-two-factor-authentication-2fa).{% endif %} | [`user`](#user-category-actions) | Contains all activities related to your account. @@ -193,19 +193,19 @@ An overview of some of the most common actions that are recorded as events in th | `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)") -| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored developer (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") | `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled | `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state -| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") -| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") -| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") -| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") -| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored developer profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored developer (see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)") {% endif %} {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md index 19604added3d..f5bc43bd2c4b 100644 --- a/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md +++ b/content/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-sponsors.md @@ -17,5 +17,5 @@ topics: ### Further reading -- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" -- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" +- "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" +- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)" diff --git a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md index 44267d9249a5..197330a751a3 100644 --- a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md @@ -56,7 +56,7 @@ You can change the name that is displayed on your profile. This name may also be ### Adding a bio to your profile -Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink. +Add a bio to your profile to share information about yourself with other {% data variables.product.product_name %} users. With the help of [@mentions](/articles/basic-writing-and-formatting-syntax) and emoji, you can include information about where you currently or have previously worked, what type of work you do, or even what kind of coffee you drink. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} diff --git a/content/github/site-policy/github-privacy-statement.md b/content/github/site-policy/github-privacy-statement.md index 50fe4dd423df..b1f638952bce 100644 --- a/content/github/site-policy/github-privacy-statement.md +++ b/content/github/site-policy/github-privacy-statement.md @@ -64,7 +64,7 @@ We require some basic information at the time of account creation. When you crea ##### Payment information If you sign on to a paid Account with us, send funds through the GitHub Sponsors Program, or buy an application on GitHub Marketplace, we collect your full name, address, and credit card information or PayPal information. Please note, GitHub does not process or store your credit card information or PayPal information, but our third-party payment processor does. -If you list and sell an application on [GitHub Marketplace](https://github.com/marketplace), we require your banking information. If you raise funds through the [GitHub Sponsors Program](https://github.com/sponsors), we require some [additional information](/github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer#submitting-your-bank-information) through the registration process for you to participate in and receive funds through those services and for compliance purposes. +If you list and sell an application on [GitHub Marketplace](https://github.com/marketplace), we require your banking information. If you raise funds through the [GitHub Sponsors Program](https://github.com/sponsors), we require some [additional information](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-bank-information) through the registration process for you to participate in and receive funds through those services and for compliance purposes. ##### Profile information You may choose to give us more information for your Account profile, such as your full name, an avatar which may include a photograph, your biography, your location, your company, and a URL to a third-party website. This information may include User Personal Information. Please note that your profile information may be visible to other Users of our Service. @@ -77,7 +77,7 @@ If you have a paid Account with us, sell an application listed on [GitHub Market ##### Usage information If you're accessing our Service or Website, we automatically collect the same basic information that most services collect, subject, where necessary, to your consent. This includes information about how you use the Service, such as the pages you view, the referring site, your IP address and session information, and the date and time of each request. This is information we collect from every visitor to the Website, whether they have an Account or not. This information may include User Personal information. -##### Cookies +##### Cookies As further described below, we automatically collect information from cookies (such as cookie ID and settings) to keep you logged in, to remember your preferences, to identify you and your device and to analyze your use of our service. ##### Device information @@ -147,7 +147,7 @@ For more information about our disclosure in response to legal requests, see our We may share User Personal Information if we are involved in a merger, sale, or acquisition of corporate entities or business units. If any such change of ownership happens, we will ensure that it is under terms that preserve the confidentiality of User Personal Information, and we will notify you on our Website or by email before any transfer of your User Personal Information. The organization receiving any User Personal Information will have to honor any promises we made in our Privacy Statement or Terms of Service. #### Aggregate, non-personally identifying information -We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events. +We share certain aggregated, non-personally identifying information with others about how our users, collectively, use GitHub, or how our users respond to our other offerings, such as our conferences or events. We **do not** sell your User Personal Information for monetary or other consideration. @@ -157,13 +157,13 @@ Please note: The California Consumer Privacy Act of 2018 (โ€œCCPAโ€) requires b #### Access to private repositories -If your repository is private, you control the access to your Content. If you include User Personal Information or Sensitive Personal Information, that information may only be accessible to GitHub in accordance with this Privacy Statement. GitHub personnel [do not access private repository content](/github/site-policy/github-terms-of-service#e-private-repositories) except for +If your repository is private, you control the access to your Content. If you include User Personal Information or Sensitive Personal Information, that information may only be accessible to GitHub in accordance with this Privacy Statement. GitHub personnel [do not access private repository content](/github/site-policy/github-terms-of-service#e-private-repositories) except for - security purposes - to assist the repository owner with a support matter - to maintain the integrity of the Service - to comply with our legal obligations -- if we have reason to believe the contents are in violation of the law, or -- with your consent. +- if we have reason to believe the contents are in violation of the law, or +- with your consent. However, while we do not generally search for content in your repositories, we may scan our servers and content to detect certain tokens or security signatures, known active malware, known vulnerabilities in dependencies, or other content known to violate our Terms of Service, such as violent extremist or terrorist content or child exploitation imagery, based on algorithmic fingerprinting techniques (collectively, "automated scanning"). Our Terms of Service provides more details on [private repositories](/github/site-policy/github-terms-of-service#e-private-repositories). @@ -238,13 +238,13 @@ That said, the email address you have supplied [via your Git commit settings](/g #### Cookies -GitHub only uses strictly necessary cookies. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors. +GitHub only uses strictly necessary cookies. Cookies are small text files that websites often store on computer hard drives or mobile devices of visitors. -We use cookies solely to provide, secure, and improve our service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, analyze your use of our service, compile statistical reports, and provide information for future development of GitHub. We use our own cookies for analytics purposes, but do not use any third-party analytics service providers. +We use cookies solely to provide, secure, and improve our service. For example, we use them to keep you logged in, remember your preferences, identify your device for security purposes, analyze your use of our service, compile statistical reports, and provide information for future development of GitHub. We use our own cookies for analytics purposes, but do not use any third-party analytics service providers. By using our service, you agree that we can place these types of cookies on your computer or device. If you disable your browser or deviceโ€™s ability to accept these cookies, you will not be able to log in or use our service. -We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. +We provide more information about [cookies on GitHub](/github/site-policy/github-subprocessors-and-cookies#cookies-on-github) on our [GitHub Subprocessors and Cookies](/github/site-policy/github-subprocessors-and-cookies) page that describes the cookies we set, the needs we have for those cookies, and the expiration of such cookies. #### DNT @@ -321,7 +321,7 @@ In the unlikely event that a dispute arises between you and GitHub regarding our ### Changes to our Privacy Statement -Although most changes are likely to be minor, GitHub may change our Privacy Statement from time to time. We will provide notification to Users of material changes to this Privacy Statement through our Website at least 30 days prior to the change taking effect by posting a notice on our home page or sending email to the primary email address specified in your GitHub account. We will also update our [Site Policy repository](https://github.com/github/site-policy/), which tracks all changes to this policy. For other changes to this Privacy Statement, we encourage Users to [watch](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) or to check our Site Policy repository frequently. +Although most changes are likely to be minor, GitHub may change our Privacy Statement from time to time. We will provide notification to Users of material changes to this Privacy Statement through our Website at least 30 days prior to the change taking effect by posting a notice on our home page or sending email to the primary email address specified in your GitHub account. We will also update our [Site Policy repository](https://github.com/github/site-policy/), which tracks all changes to this policy. For other changes to this Privacy Statement, we encourage Users to [watch](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository) or to check our Site Policy repository frequently. ### License diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md b/content/github/supporting-the-open-source-community-with-github-sponsors/index.md deleted file mode 100644 index 39d60b8feb7c..000000000000 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/index.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: Supporting the open source community with GitHub Sponsors -shortTitle: GitHub Sponsors -intro: 'You can support the people and organizations who design, build, and maintain the open source projects you depend on by compensating them via {% data variables.product.prodname_dotcom %}.' -redirect_from: - - /categories/supporting-the-open-source-community-with-github-sponsors -versions: - free-pro-team: '*' -topics: - - sponsors ---- - - -### Table of Contents - -{% topic_link_in_list /overview %} - {% link_in_list /about-github-sponsors %} -{% topic_link_in_list /sponsoring-open-source-contributors %} - {% link_in_list /sponsoring-an-open-source-contributor %} - {% link_in_list /managing-your-sponsorship %} - {% link_in_list /attributing-sponsorships-to-your-organization %} -{% topic_link_in_list /receiving-sponsorships-through-github-sponsors %} - {% link_in_list /about-github-sponsors-for-open-source-contributors %} - {% link_in_list /setting-up-github-sponsors-for-your-user-account %} - {% link_in_list /setting-up-github-sponsors-for-your-organization %} - {% link_in_list /editing-your-profile-details-for-github-sponsors %} - {% link_in_list /managing-your-sponsorship-goal %} - {% link_in_list /managing-your-sponsorship-tiers %} - {% link_in_list /viewing-your-sponsors-and-sponsorships %} - {% link_in_list /managing-your-payouts-from-github-sponsors %} - {% link_in_list /configuring-webhooks-for-events-in-your-sponsored-account %} - {% link_in_list /contacting-your-sponsors %} - {% link_in_list /tax-information-for-github-sponsors %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md b/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md deleted file mode 100644 index fb2a1f92f9f8..000000000000 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -title: Receiving sponsorships through GitHub Sponsors -shortTitle: Receiving sponsorships -intro: 'You or your organization can become a sponsored open source contributor to receive payments for your work, update your sponsorship details, and view and contact your sponsors.' -mapTopic: true -redirect_from: - - /articles/receiving-sponsorships-as-a-sponsored-developer - - /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-as-a-sponsored-developer -versions: - free-pro-team: '*' -topics: - - sponsors ---- - diff --git a/content/index.md b/content/index.md index 82990b3fbb93..b95dbb683bef 100644 --- a/content/index.md +++ b/content/index.md @@ -25,6 +25,7 @@ children: - graphql - insights - discussions + - sponsors - communities - pages - education @@ -52,4 +53,3 @@ externalProducts: href: 'https://codeql.github.com/docs' external: true --- - diff --git a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md index a4d5c74ff164..7df881304bb7 100644 --- a/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization.md @@ -144,9 +144,9 @@ For example, you can make a GraphQL request to see all the new organization memb #### Using the REST API -{% note %} +{% note %} -**Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. +**Note:** The audit log REST API is available for users of {% data variables.product.prodname_ghe_cloud %} only. {% endnote %} @@ -643,19 +643,19 @@ For more information, see "[Managing the publication of {% data variables.produc | `custom_amount_settings_change` | Triggered when you enable or disable custom amounts, or when you change the suggested custom amount (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") | `repo_funding_links_file_action` | Triggered when you change the FUNDING file in your repository (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)") | `sponsor_sponsorship_cancel` | Triggered when you cancel a sponsorship (see "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor)") -| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/articles/managing-your-sponsorship)") +| `sponsor_sponsorship_create` | Triggered when you sponsor an account (see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)") +| `sponsor_sponsorship_preference_change` | Triggered when you change whether you receive email updates from a sponsored account (see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)") | `sponsor_sponsorship_tier_change` | Triggered when you upgrade or downgrade your sponsorship (see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)") -| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") -| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_approve` | Triggered when your {% data variables.product.prodname_sponsors %} account is approved (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_create` | Triggered when your {% data variables.product.prodname_sponsors %} account is created (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") | `sponsored_developer_disable` | Triggered when your {% data variables.product.prodname_sponsors %} account is disabled | `sponsored_developer_redraft` | Triggered when your {% data variables.product.prodname_sponsors %} account is returned to draft state from approved state -| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)") -| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") -| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)") -| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/articles/contacting-your-sponsors)") -| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") -| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_profile_update` | Triggered when you edit your sponsored organization profile (see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)") +| `sponsored_developer_request_approval` | Triggered when you submit your application for {% data variables.product.prodname_sponsors %} for approval (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `sponsored_developer_tier_description_update` | Triggered when you change the description for a sponsorship tier (see "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)") +| `sponsored_developer_update_newsletter_send` | Triggered when you send an email update to your sponsors (see "[Contacting your sponsors](/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors)") +| `waitlist_invite_sponsored_developer` | Triggered when you are invited to join {% data variables.product.prodname_sponsors %} from the waitlist (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") +| `waitlist_join` | Triggered when you join the waitlist to become a sponsored organization (see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)") {% endif %} #### `team` category actions diff --git a/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md index a3e01ff5a73f..56b192ffdb38 100644 --- a/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md +++ b/content/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors.md @@ -11,11 +11,11 @@ topics: - teams --- -{% data reusables.sponsors.org-sponsors-release-phase %} +{% data reusables.sponsors.org-sponsors-release-phase %} -The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates. +The developers and organizations that your organization sponsors can send you updates about their work. You can manage the email address that receives these updates. -You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)." +You can also disable updates from accounts your organization sponsors. For more information, see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship#managing-email-updates-for-your-sponsorship)." {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} @@ -27,4 +27,4 @@ You can also disable updates from accounts your organization sponsors. For more ### Further reading -- "[Supporting the open source community with {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors)" +- "[{% data variables.product.prodname_sponsors %}](/sponsors)" diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md index 818a082bfabf..fc77ec04cd80 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/permission-levels-for-an-organization.md @@ -60,9 +60,9 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | Disable team discussions for an organization (see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)" for details) | **X** | | | | Manage viewing of organization dependency insights (see "[Changing the visibility of your organization's dependency insights](/articles/changing-the-visibility-of-your-organizations-dependency-insights)" for details) | **X** | | | | Set a team profile picture in **all teams** (see "[Setting your team's profile picture](/articles/setting-your-team-s-profile-picture)" for details) | **X** | | | -| Sponsor accounts and manage the organization's sponsorships (see "[Sponsoring open-source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" for details) | **X** | **X** | | +| Sponsor accounts and manage the organization's sponsorships (see "[Sponsoring open-source contributors](/sponsors/sponsoring-open-source-contributors)" for details) | **X** | **X** | | | Manage email updates from sponsored accounts (see "[Managing updates from accounts your organization's sponsors](/organizations/managing-organization-settings/managing-updates-from-accounts-your-organization-sponsors)" for details) | **X** | | | -| Attribute your sponsorships to another organization (see "[Attributing sponsorships to your organization](/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization)" for details ) | **X** | | | +| Attribute your sponsorships to another organization (see "[Attributing sponsorships to your organization](/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization)" for details ) | **X** | | | | Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[Managing the publication of {% data variables.product.prodname_pages %} sites for your organization](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)" for details) | **X** | | | | Manage security and analysis settings (see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization)" for details) | **X** | | | | Enable and enforce [SAML single sign-on](/articles/about-identity-and-access-management-with-saml-single-sign-on) | **X** | | | diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md similarity index 69% rename from content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md rename to content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md index a93f6df83a45..84e96106171f 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors.md +++ b/content/sponsors/getting-started-with-github-sponsors/about-github-sponsors.md @@ -3,21 +3,24 @@ title: About GitHub Sponsors intro: '{% data variables.product.prodname_sponsors %} allows the developer community to financially support the people and organizations who design, build, and maintain the open source projects they depend on, directly on {% data variables.product.product_name %}.' redirect_from: - /articles/about-github-sponsors + - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors versions: free-pro-team: '*' +type: 'overview' topics: - - sponsors + - 'Open Source' + - 'Fundamentals' --- ### About {% data variables.product.prodname_sponsors %} -{% data reusables.sponsors.sponsorship-details %} +{% data reusables.sponsors.sponsorship-details %} {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)" and "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." When you become a sponsored developer or sponsored organization, additional terms for {% data variables.product.prodname_sponsors %} apply. For more information, see "[GitHub Sponsors Additional Terms](/github/site-policy/github-sponsors-additional-terms)." @@ -31,7 +34,9 @@ When you become a sponsored developer or sponsored organization, additional term The {% data variables.product.prodname_matching_fund %} aims to benefit members of the {% data variables.product.prodname_dotcom %} community who develop open source software that promotes the [{% data variables.product.prodname_dotcom %} Community Guidelines](/github/site-policy/github.amrom.workers.devmunity-guidelines). Payments to sponsored organizations and payments from organizations are not eligible for {% data variables.product.prodname_matching_fund %}. -To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors)." +To be eligible for the {% data variables.product.prodname_matching_fund %}, you must create a profile that will attract a community that will sustain you for the long term. For more information about creating a strong profile, see "[Editing your profile details for {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors)." + +Donations between sponsored developers will not be matched. {% data reusables.sponsors.legal-additional-terms %} @@ -40,6 +45,6 @@ To be eligible for the {% data variables.product.prodname_matching_fund %}, you {% data reusables.sponsors.feedback %} ### Further reading -- "[Sponsoring open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors)" -- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors)" +- "[Sponsoring open source contributors](/sponsors/sponsoring-open-source-contributors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" - "[FAQ with the {% data variables.product.prodname_sponsors %} team](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)" on {% data variables.product.prodname_blog %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md b/content/sponsors/getting-started-with-github-sponsors/index.md similarity index 52% rename from content/github/supporting-the-open-source-community-with-github-sponsors/overview.md rename to content/sponsors/getting-started-with-github-sponsors/index.md index b068234cb2f3..4c473a58692c 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/overview.md +++ b/content/sponsors/getting-started-with-github-sponsors/index.md @@ -1,10 +1,10 @@ --- -title: Overview +title: Getting started with GitHub Sponsors intro: 'Learn about {% data variables.product.prodname_sponsors %} and how you can get involved as a sponsor or open source contributor.' -mapTopic: true versions: free-pro-team: '*' -topics: - - sponsors --- +{% link_with_intro /about-github-sponsors %} + +{% link_with_intro /quickstart-for-finding-contributors-to-sponsor %} diff --git a/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md b/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md new file mode 100644 index 000000000000..df3ccc248049 --- /dev/null +++ b/content/sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor.md @@ -0,0 +1,51 @@ +--- +title: Quickstart for finding contributors to sponsor +intro: 'Learn some best practices for finding open source contributors to sponsor.' +versions: + free-pro-team: '*' +type: 'quick_start' +topics: + - 'Open Source' +--- + +### Explore projects you depend on + +As you consider where to find open source contributors to sponsor, consider starting at https://github.com/sponsors/community. + +If you're logged in, the sponsors results will start with public dependencies that your repositories depend on. + +![The Babel open source project with highlighted text that says "4 of your repositories depend on this"](/assets/images/help/sponsors/example-of-open-source-project-dependency.png) + +You can also toggle which of your accounts to view results for and further filter or search. + +![Search options on sponsors community search page](/assets/images/help/sponsors/sponsors-search-options.png) + +### Explore whom others sponsor + +You can see whom a user or organization sponsors on their {% data variables.product.prodname_dotcom %} profile page. + +### Consider how you benefit from different contributions + +Consider whether you benefit from the work of open source contributions, such as: + - Documentation + - Design + - Translation + - Newsletters + - Code reviews + - Tutorials + - Mentoring + - Triaging issues and helping with project management + - Answering questions + - Event planning + +For more information on different types of open source contributions, see the [Open source guide](https://opensource.guide/how-to-contribute/#you-dont-have-to-contribute-code). + +You can check if contributors you've benefited from have {% data variables.product.prodname_sponsors %} profiles by using search at https://github.com/sponsors/community. + +### Search for a specific project or contributor + +At https://github.com/sponsors/community, you can search by ecosystem, most used, recently updated, and more. You can filter search results for your personal user account or for organizations that you're a member of. + +### Next steps + +For more information on starting your sponsorship, see "[Sponsoring an open source contributor](/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor)." diff --git a/content/sponsors/guides.md b/content/sponsors/guides.md new file mode 100644 index 000000000000..45d4336ca0de --- /dev/null +++ b/content/sponsors/guides.md @@ -0,0 +1,17 @@ +--- +title: GitHub Sponsors guides +shortTitle: Guides +intro: 'Learn how to make the most of {% data variables.product.prodname_sponsors %}.' +allowTitleToDifferFromFilename: true +layout: product-sublanding +versions: + free-pro-team: '*' +includeGuides: + - /sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor + - /sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization + - /sponsors/sponsoring-open-source-contributors/managing-your-sponsorship + - /sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors + - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account + - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization + - /sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account +--- \ No newline at end of file diff --git a/content/sponsors/index.md b/content/sponsors/index.md new file mode 100644 index 000000000000..efd1738d8a42 --- /dev/null +++ b/content/sponsors/index.md @@ -0,0 +1,35 @@ +--- +title: GitHub Sponsors Documentation +shortTitle: GitHub Sponsors +intro: 'Invest in the open source projects you depend on, support digital infrastructure, and make open source careers possible by sponsoring open source contributors and their projects. Build a {% data variables.product.prodname_sponsors %} profile and receive compensation for your open source work.' +introLinks: + quickstart: /sponsors/getting-started-with-github-sponsors/quickstart-for-finding-contributors-to-sponsor +redirect_from: + - /categories/supporting-the-open-source-community-with-github-sponsors + - /github/supporting-the-open-source-community-with-github-sponsors +changelog: + label: 'sponsors' +featuredLinks: + guides: + - /sponsors/sponsoring-open-source-contributors/managing-your-sponsorship + - /sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization + - /sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors + guideCards: + - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account + - /sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization + - /sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account + popular: + - /sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor + - /sponsors/getting-started-with-github-sponsors/about-github-sponsors + - /sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors + - /sponsors/sponsoring-open-source-contributors + - /sponsors/about-github-sponsors-for-open-source-contributors +layout: product-landing +versions: + free-pro-team: '*' +--- + + + + + diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md b/content/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md similarity index 85% rename from content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md rename to content/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md index 861e9dd6de33..6c2a98c2bfc3 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md +++ b/content/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account.md @@ -1,10 +1,15 @@ --- title: Configuring webhooks for events in your sponsored account intro: You can configure webhooks to alert you when you receive new sponsorships or existing sponsors make changes to their sponsorships. +redirect_from: + - /github/supporting-the-open-source-community-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Webhooks' + - 'Events' + - 'Open Source' --- ### About webhooks for events in your sponsored account diff --git a/content/sponsors/integrating-with-github-sponsors/getting-started-with-the-sponsors-graphql-api.md b/content/sponsors/integrating-with-github-sponsors/getting-started-with-the-sponsors-graphql-api.md new file mode 100644 index 000000000000..34b2d628bef0 --- /dev/null +++ b/content/sponsors/integrating-with-github-sponsors/getting-started-with-the-sponsors-graphql-api.md @@ -0,0 +1,14 @@ +--- +title: Getting started with the Sponsors GraphQL API +intro: 'Using the GraphQL API, you can build custom integrations to manage or review your sponsorships.' +versions: + free-pro-team: '*' +type: 'overview' +topics: + - 'GraphQL' + - 'API' +--- + +To get started with the GraphQL API, see "[Introduction to GraphQL](/graphql/guides/introduction-to-graphql)." + +You can find the details about the Sponsors GraphQL API in the reference docs. For more information, see "[GraphQL reference](/graphql/reference)." We recommend using the GraphQL explorer to build your GraphQL calls. For more information, see "[Using the explorer](/graphql/guides/using-the-explorer)." diff --git a/content/sponsors/integrating-with-github-sponsors/index.md b/content/sponsors/integrating-with-github-sponsors/index.md new file mode 100644 index 000000000000..37e7055360f2 --- /dev/null +++ b/content/sponsors/integrating-with-github-sponsors/index.md @@ -0,0 +1,9 @@ +--- +title: Integrating with GitHub Sponsors +intro: 'As an open source contributor, you can build custom tools to manage your GitHub sponsorships.' +versions: + free-pro-team: '*' +--- + +{% link_with_intro /configuring-webhooks-for-events-in-your-sponsored-account %} +{% link_with_intro /getting-started-with-the-sponsors-graphql-api %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md similarity index 66% rename from content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md index 5d9db833389c..19f22259433e 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors.md @@ -6,25 +6,27 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-sponsored-developers versions: free-pro-team: '*' +type: 'overview' topics: - - sponsors + - 'Open Source' + - 'Fundamentals' --- ### Joining {% data variables.product.prodname_sponsors %} -{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +{% data reusables.sponsors.you-can-be-a-sponsored-developer %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." -{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." +{% data reusables.sponsors.you-can-be-a-sponsored-organization %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." After you join {% data variables.product.prodname_sponsors %}, you can add a sponsor button to the open source repository you contribute to, to increase the visibility of your {% data variables.product.prodname_sponsors %} profile and other funding platforms. For more information, see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)." -You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal)." +You can set a goal for your sponsorships. For more information, see "[Managing your sponsorship goal](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal)." {% data reusables.sponsors.github-contact-applicants %} ### Sponsorship tiers -{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers)." +{% data reusables.sponsors.tier-details %} For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)," "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization), and "[Managing your sponsorship tiers](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers)." It's best to set up a range of different sponsorship options, including monthly and one-time tiers, to make it easy for anyone to support your work. In particular, one-time payments allow people to reward your efforts without worrying about whether their finances will support a regular payment schedule. @@ -34,7 +36,7 @@ It's best to set up a range of different sponsorship options, including monthly {% data reusables.sponsors.payout-info %} -For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors)." +For more information, see "[Managing your payouts from {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors)." ### Sharing feedback about {% data variables.product.prodname_sponsors %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md similarity index 83% rename from content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md index de523d754e5f..406bc187f181 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/contacting-your-sponsors.md @@ -3,20 +3,21 @@ title: Contacting your sponsors intro: You can send an email to your sponsors who have opted in to receive updates about your work. redirect_from: - /articles/contacting-your-sponsors + - /github/supporting-the-open-source-community-with-github-sponsors/contacting-your-sponsors versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Open Source' + - 'Contacting sponsors' --- ### About sponsorship updates -Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/articles/managing-your-sponsorship)." +Your sponsors can choose whether they receive email updates about your work. For more information, see "[Managing your sponsorship](/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship)." For sponsored developer accounts, the update will come from your user account's primary email address. If you've enabled email address privacy on your user account, the update will come from `noreply@github.com` instead. For sponsored organizations, the update will come from the organization's `noreply@github.com` email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." -You can also contact any one-time sponsors who contributed within the last 30 days and enabled updates. - ### Contacting your sponsors {% data reusables.sponsors.navigate-to-sponsors-dashboard %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md similarity index 86% rename from content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md index 83b554458180..fc11e798b10d 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/editing-your-profile-details-for-github-sponsors.md @@ -4,10 +4,13 @@ intro: You can update the information that potential sponsors see about your wor redirect_from: - /articles/editing-your-sponsored-developer-profile - /github/supporting-the-open-source-community-with-github-sponsors/editing-your-sponsored-developer-profile + - /github/supporting-the-open-source-community-with-github-sponsors/editing-your-profile-details-for-github-sponsors versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Sponsors profile' + - 'Open Source' --- ### About sponsor profiles diff --git a/content/sponsors/receiving-sponsorships-through-github-sponsors/index.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/index.md new file mode 100644 index 000000000000..eb4b28abc1ed --- /dev/null +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/index.md @@ -0,0 +1,22 @@ +--- +title: Receiving sponsorships through GitHub Sponsors +shortTitle: Receiving sponsorships +intro: 'You or your organization can become a sponsored open source contributor to receive payments for your work, update your sponsorship details, and view and contact your sponsors.' +redirect_from: + - /articles/receiving-sponsorships-as-a-sponsored-developer + - /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-as-a-sponsored-developer + - /github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors +versions: + free-pro-team: '*' +--- + +{% link_with_intro /about-github-sponsors-for-open-source-contributors %} +{% link_with_intro /setting-up-github-sponsors-for-your-user-account %} +{% link_with_intro /setting-up-github-sponsors-for-your-organization %} +{% link_with_intro /editing-your-profile-details-for-github-sponsors %} +{% link_with_intro /managing-your-sponsorship-goal %} +{% link_with_intro /managing-your-sponsorship-tiers %} +{% link_with_intro /viewing-your-sponsors-and-sponsorships %} +{% link_with_intro /managing-your-payouts-from-github-sponsors %} +{% link_with_intro /contacting-your-sponsors %} +{% link_with_intro /tax-information-for-github-sponsors %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md similarity index 76% rename from content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md index caa157285541..1e9bdbfad24f 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-payouts-from-github-sponsors.md @@ -3,15 +3,18 @@ title: Managing your payouts from GitHub Sponsors intro: 'You can view information about past and future payouts from {% data variables.product.prodname_sponsors %} and edit your bank information.' redirect_from: - /articles/managing-your-payouts-from-github-sponsors + - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-payouts-from-github-sponsors versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Sponsors payments' + - 'Open Source' --- ### About payouts from {% data variables.product.prodname_sponsors %} -You can only manage your payouts from {% data variables.product.prodname_sponsors %} if you are paid through Stripe Connect. If you are paid through ACH transfer or wire transfer for your sponsored user account, you will not see the **Payouts** tab on your sponsored open source contributor dashboard. Sponsored organizations can only use Stripe Connect for payouts. For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors-for-open-source-contributors#sponsorship-payouts)." +You can only manage your payouts from {% data variables.product.prodname_sponsors %} if you are paid through Stripe Connect. If you are paid through ACH transfer or wire transfer for your sponsored user account, you will not see the **Payouts** tab on your sponsored open source contributor dashboard. Sponsored organizations can only use Stripe Connect for payouts. For more information, see "[About {% data variables.product.prodname_sponsors %} for open source contributors](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors#sponsorship-payouts)." {% data reusables.sponsors.payout-info %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal.md similarity index 86% rename from content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal.md index 9991858a5845..0e64a0f99108 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-goal.md @@ -1,10 +1,15 @@ --- title: Managing your sponsorship goal intro: You can set a goal for your sponsored developer or sponsored organization account to help the community understand the impact of sponsoring you. +redirect_from: + - /github/supporting-the-open-source-community-with-github-sponsors/manage-your-sponsorship-goal + - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-goal versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Open Source' + - 'Sponsors profile' --- ### About sponsorship goals @@ -13,12 +18,6 @@ You can set a funding goal for your sponsored account and share the goal with yo Your goal can set a target for the number of sponsors you want to have or the amount of money you want to earn each month. You can only set one goal up at a time. After you reach a goal, you can set another goal. -{% note %} - -**Note:** Goals are intended to help people track momentum so only monthly sponsors contribute toward your goal. - -{% endnote %} - ### Setting a goal {% data reusables.sponsors.navigate-to-sponsors-dashboard %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md similarity index 90% rename from content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md index efb3ada4b597..e399b8a6675d 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/managing-your-sponsorship-tiers.md @@ -4,10 +4,13 @@ intro: 'You can add a new sponsorship tier, or edit or retire an existing tier.' redirect_from: - /articles/changing-your-sponsorship-tiers - /github/supporting-the-open-source-community-with-github-sponsors/changing-your-sponsorship-tiers + - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship-tiers versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Open Source' + - 'Sponsors profile' --- ### About sponsorship tiers diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md similarity index 89% rename from content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md index a73b66dc54b0..02178b1e59cf 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization.md @@ -4,11 +4,15 @@ intro: 'Your organization can join {% data variables.product.prodname_sponsors % redirect_from: - /articles/setting-up-github-sponsorship-for-your-organization - /articles/receiving-sponsorships-as-a-sponsored-organization + - /github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization permissions: 'Organization owners can set up {% data variables.product.prodname_sponsors %} for an organization.' versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Organizations' + - 'Sponsors profile' + - 'Open Source' --- ### Joining {% data variables.product.prodname_sponsors %} @@ -17,7 +21,7 @@ topics: After you receive an invitation for your organization to join {% data variables.product.prodname_sponsors %}, you can complete the steps below to become a sponsored organization. -To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)." +To join {% data variables.product.prodname_sponsors %} as an individual contributor outside an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)." {% data reusables.sponsors.navigate-to-github-sponsors %} {% data reusables.sponsors.view-eligible-accounts %} @@ -48,7 +52,6 @@ To join {% data variables.product.prodname_sponsors %} as an individual contribu {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.review-and-publish-tier %} -{% data reusables.sponsors.enable-custom-amounts %} {% data reusables.sponsors.add-more-tiers %} ### Submitting your bank information @@ -84,5 +87,5 @@ Before your organization can become a sponsored organization, you must enable 2F {% data reusables.sponsors.github-review-app %} ### Further reading -- "[About {% data variables.product.prodname_sponsors %}](/articles/about-github-sponsors)" -- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/github/supporting-the-open-source-community-with-github-sponsors/receiving-sponsorships-through-github-sponsors)" +- "[About {% data variables.product.prodname_sponsors %}](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)" +- "[Receiving sponsorships through {% data variables.product.prodname_sponsors %}](/sponsors/receiving-sponsorships-through-github-sponsors)" diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md similarity index 92% rename from content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md index b42f036470b1..9855a76d6235 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md @@ -4,17 +4,20 @@ intro: 'You can become a sponsored developer by joining {% data variables.produc redirect_from: - /articles/becoming-a-sponsored-developer - /github/supporting-the-open-source-community-with-github-sponsors/becoming-a-sponsored-developer + - /github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'User account' + - 'Sponsors profile' --- ### Joining {% data variables.product.prodname_sponsors %} {% data reusables.sponsors.you-can-be-a-sponsored-developer %} {% data reusables.sponsors.stripe-supported-regions %} -To join {% data variables.product.prodname_sponsors %} as an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." +To join {% data variables.product.prodname_sponsors %} as an organization, see "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.navigate-to-github-sponsors %} 2. If you are an organization owner, you have more than one eligible account. Click **View your eligible accounts**, then in the list of accounts, find your user account. @@ -48,7 +51,6 @@ After {% data variables.product.prodname_dotcom %} reviews your application, you {% data reusables.sponsors.tier-price-description %} {% data reusables.sponsors.save-tier-draft %} {% data reusables.sponsors.review-and-publish-tier %} -{% data reusables.sponsors.enable-custom-amounts %} {% data reusables.sponsors.add-more-tiers %} ### Submitting your bank information diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md similarity index 54% rename from content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md index 82ebe0fca012..373ec09dc57b 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-github-sponsors.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/tax-information-for-github-sponsors.md @@ -6,13 +6,15 @@ redirect_from: - /github/supporting-the-open-source-community-with-github-sponsors/tax-information-for-sponsored-developers versions: free-pro-team: '*' +type: 'overview' topics: - - sponsors + - 'Open Source' + - 'Sponsors payments' --- -If you are a taxpayer in the United States, you must submit a W-9 before you can receive payments. If you are a taxpayer in any other region besides the United States, you must submit a W-8BEN before you can receive payments. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-tax-information)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms. +If you are a taxpayer in the United States, you must submit a W-9 before you can receive payments. If you are a taxpayer in any other region besides the United States, you must submit a W-8BEN before you can receive payments. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account#submitting-your-tax-information)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization#submitting-your-tax-information)." {% data variables.product.prodname_dotcom %} will send you the appropriate forms, notify you when they are due, and give you a reasonable amount of time to complete and send in the forms. -If you are a taxpayer in the United States and earn more than $600 in a tax year, {% data variables.product.prodname_dotcom %} will send you a 1099 before January 31 of the next calendar year. We do not provide tax forms for international taxpayers. +If you are a taxpayer in the United States and earn more than $600 USD in a tax year, {% data variables.product.prodname_dotcom %} will send you a 1099 before January 31 of the next calendar year. We do not provide tax forms for international taxpayers. {% data variables.product.prodname_dotcom %} does not withhold tax from {% data variables.product.prodname_sponsors %} payments. Sponsored developers are responsible for evaluating and paying their own taxes. @@ -20,4 +22,4 @@ If you are a taxpayer in the United States and earn more than $600 in a tax year ### Further reading -- [Viewing your sponsors and sponsorships](/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships) +- [Viewing your sponsors and sponsorships](/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships) diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md b/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md similarity index 90% rename from content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md rename to content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md index 79bd24bdcc85..668ccedc1a4a 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships.md +++ b/content/sponsors/receiving-sponsorships-through-github-sponsors/viewing-your-sponsors-and-sponsorships.md @@ -3,15 +3,18 @@ title: Viewing your sponsors and sponsorships intro: You can view and export detailed information and analytics about your sponsors and sponsorships. redirect_from: - /articles/viewing-your-sponsors-and-sponsorships + - /github/supporting-the-open-source-community-with-github-sponsors/viewing-your-sponsors-and-sponsorships versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Open Source' + - 'Analytics' --- ### About sponsors and sponsorships -You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format. +You can view analytics on your current and past sponsorships, the payments you've received from sponsors, and events, such as cancellations and sponsor tier changes for your sponsorships. You can also view activity such as new sponsorships, changes to sponsorships, and canceled sponsorships. You can filter the list of activities by date. You can also export sponsorship data for the account you're viewing in CSV or JSON format. ### Viewing your sponsors and sponsorships diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md b/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md similarity index 80% rename from content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md rename to content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md index f85f61fdfca8..e228ad265555 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization.md +++ b/content/sponsors/sponsoring-open-source-contributors/attributing-sponsorships-to-your-organization.md @@ -1,15 +1,20 @@ --- title: Attributing sponsorships to your organization intro: You can attribute the sponsorships paid by one of your organizations to another organization. +redirect_from: + - /github/supporting-the-open-source-community-with-github-sponsors/attributing-sponsorships-to-your-organization versions: free-pro-team: '*' permissions: People who are organization owners of both organizations can attribute one organization's sponsorships to another organization. +type: 'how_to' topics: - - sponsors + - 'Open Source' + - 'Organizations' + - 'Sponsors profile' --- 1. Navigate to the organization whose sponsorships you want to attribute to another organization. -1. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. +2. Under your organization name, click {% octicon "heart" aria-label="The heart icon" %} **Sponsoring**. !["Sponsoring" tab](/assets/images/help/sponsors/sponsoring-tab.png) 1. In the upper-right corner, click {% octicon "gear" aria-label="The gear icon" %} **Settings**. !["Settings" button](/assets/images/help/sponsors/sponsoring-settings-button.png) diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md b/content/sponsors/sponsoring-open-source-contributors/index.md similarity index 60% rename from content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md rename to content/sponsors/sponsoring-open-source-contributors/index.md index afbdabd06ac0..5bfcaebe24ae 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors.md +++ b/content/sponsors/sponsoring-open-source-contributors/index.md @@ -1,13 +1,14 @@ --- title: Sponsoring open source contributors intro: 'You can sponsor contributors, receive updates on developers and organizations you sponsor, and display a sponsor badge throughout {% data variables.product.product_name %}.' -mapTopic: true redirect_from: - /articles/sponsoring-open-source-developers - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-developers + - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-open-source-contributors versions: free-pro-team: '*' -topics: - - sponsors --- +{% link_with_intro /sponsoring-an-open-source-contributor %} +{% link_with_intro /managing-your-sponsorship %} +{% link_with_intro /attributing-sponsorships-to-your-organization %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md b/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md similarity index 81% rename from content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md rename to content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md index 2088f90c193c..642e8c4e7526 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship.md +++ b/content/sponsors/sponsoring-open-source-contributors/managing-your-sponsorship.md @@ -3,13 +3,17 @@ title: Managing your sponsorship intro: You can manage who can see your sponsorship and whether you receive email updates from the sponsored account. redirect_from: - /articles/managing-your-sponsorship + - /github/supporting-the-open-source-community-with-github-sponsors/managing-your-sponsorship versions: free-pro-team: '*' +type: 'how_to' topics: - - sponsors + - 'Contacting sponsors' + - 'Privacy' + - 'Open Source' --- -{% data reusables.sponsors.org-sponsors-release-phase %} +{% data reusables.sponsors.org-sponsors-release-phase %} ### Managing the privacy setting for your sponsorship @@ -23,7 +27,7 @@ topics: You can choose whether an account you sponsor can send you email updates about their work. The sponsored account will not have access to your email address. -{% data reusables.sponsors.manage-updates-for-orgs %} +{% data reusables.sponsors.manage-updates-for-orgs %} {% data reusables.sponsors.navigate-to-sponsored-account %} {% data reusables.sponsors.sponsorship-dashboard %} diff --git a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md similarity index 76% rename from content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md rename to content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md index aa7befca8210..fedec9b4ba88 100644 --- a/content/github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor.md +++ b/content/sponsors/sponsoring-open-source-contributors/sponsoring-an-open-source-contributor.md @@ -1,22 +1,25 @@ --- title: Sponsoring an open source contributor -intro: 'You can make a one-time or monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.' +intro: 'You can make a monthly recurring payment to a developer or organization who designs, creates, or maintains open source projects you depend on.' redirect_from: - /articles/sponsoring-a-developer - /articles/sponsoring-an-open-source-contributor - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-a-developer + - /github/supporting-the-open-source-community-with-github-sponsors/sponsoring-an-open-source-contributor versions: free-pro-team: '*' permissions: Anyone can sponsor accounts on behalf of their own user account. Organization owners and billing managers can sponsor accounts on behalf of their organization. +type: 'how_to' topics: - - sponsors + - 'Open Source' + - 'Sponsors payments' --- -{% data reusables.sponsors.org-sponsors-release-phase %} +{% data reusables.sponsors.org-sponsors-release-phase %} ### About sponsorships -{% data reusables.sponsors.sponsorship-details %} +{% data reusables.sponsors.sponsorship-details %} You can sponsor an account on behalf of your user account to invest in projects that you personally benefit from. You can sponsor an account on behalf of your organization for many reasons. - Sustaining specific libraries that your organization's work depends on @@ -24,17 +27,17 @@ You can sponsor an account on behalf of your user account to invest in projects - Developing brand awareness as an organization that values open source - Thanking open source developers for building libraries that complement the product your organization offers -You use your normal payment method to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, [contact us](https://support.github.com/contact/org-sponsors-waitlist). +You can use a credit card to sponsor an account on {% data variables.product.product_name %}. If your organization wants to pay by invoice, [contact us](https://support.github.com/contact/org-sponsors-waitlist). {% data reusables.sponsors.no-fees %} For more information, see "[About billing for {% data variables.product.prodname_sponsors %}](/articles/about-billing-for-github-sponsors)." -When you sponsor an account the change is effective immediately, unless you are sponsoring on behalf of an organization that pays by invoice. {% data reusables.sponsors.prorated-sponsorship %} Your sponsorship is included in the next scheduled payment to the sponsored account. +When you sponsor an account using a credit card, the change will become effective immediately. {% data reusables.sponsors.prorated-sponsorship %} -{% data reusables.sponsors.manage-updates-for-orgs %} +{% data reusables.sponsors.manage-updates-for-orgs %} If the sponsored account retires your tier, the tier will remain in place for you until you choose a different tier or cancel your subscription. For more information, see "[Upgrading a sponsorship](/articles/upgrading-a-sponsorship)" and "[Downgrading a sponsorship](/articles/downgrading-a-sponsorship)." -If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/github/supporting-the-open-source-community-with-github-sponsors/setting-up-github-sponsors-for-your-organization)." +If the account you want to sponsor does not have a profile on {% data variables.product.prodname_sponsors %}, you can encourage the account to join. For more information, see "[Setting up {% data variables.product.prodname_sponsors %} for your user account](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account)" and "[Setting up {% data variables.product.prodname_sponsors %} for your organization](/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-organization)." {% data reusables.sponsors.sponsorships-not-tax-deductible %} @@ -56,7 +59,6 @@ Before you can sponsor an account, you must have a verified email address. For m ![Sponsor button](/assets/images/help/sponsors/sponsor-org-button.png) 1. Optionally, on the right side of the page, to sponsor the account on behalf of your organization, use the **Sponsor as** drop-down menu, and click the organization. ![Drop-down menu to choose the account you'll sponsor as](/assets/images/help/sponsors/sponsor-as-drop-down-menu.png) -{% data reusables.sponsors.review-tiers-to-select %} {% data reusables.sponsors.select-a-tier %} {% data reusables.sponsors.pay-prorated-amount %} {% data reusables.sponsors.select-sponsorship-billing %} diff --git a/data/allowed-topics.js b/data/allowed-topics.js index 68e6287fc90c..8abb382cb291 100644 --- a/data/allowed-topics.js +++ b/data/allowed-topics.js @@ -15,35 +15,47 @@ module.exports = [ 'Action development', 'Amazon ECS', 'Ant', + 'Analytics', + 'API', 'Azure App Service', 'Azure Pipelines', 'CD', 'CI', 'CircleCI', + 'Contacting sponsors', 'Containers', 'Docker', + 'Events', 'Fundamentals', 'GitLab', 'Google Kubernetes Engine', 'Gradle', + 'GraphQL', 'Java', 'JavaScript', 'Jenkins', 'Maven', 'Migration', 'Node', + 'Open Source', + 'Organizations', 'Packaging', 'Powershell', + 'Privacy', 'Project management', 'Publishing', 'Python', 'Ruby', 'Security', + 'Sponsors payments', + 'Sponsors profile', 'Travis CI', + 'User account', + 'Webhooks', 'Workflows', 'access management', 'accounts', - 'api', + 'api', // replace this with API 'billing', 'cli', 'codespaces', @@ -52,7 +64,7 @@ module.exports = [ 'device verification', 'early access', 'enterprise', - 'events', + 'events', // replace this with Events 'github', 'github apps', 'github search', @@ -64,8 +76,8 @@ module.exports = [ 'mobile', 'notifications', 'oauth apps', - 'open source', - 'organizations', + 'open source', // replace this with Open Source + 'organizations', // replace this with Organization 'pages', 'permissions', 'policy', @@ -75,11 +87,10 @@ module.exports = [ 'pull requests', 'repositories', 'security', - 'sponsors', 'ssh', 'sso', 'teams', 'usernames', - 'webhooks', + 'webhooks', // replace this with Webhooks 'Xcode' ] diff --git a/data/reusables/webhooks/sponsorship_short_desc.md b/data/reusables/webhooks/sponsorship_short_desc.md index 2f62ffe8d86a..bf99f9f71a20 100644 --- a/data/reusables/webhooks/sponsorship_short_desc.md +++ b/data/reusables/webhooks/sponsorship_short_desc.md @@ -1 +1 @@ -Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see "[About GitHub Sponsors](/github/supporting-the-open-source-community-with-github-sponsors/about-github-sponsors)". +Activity related to a sponsorship listing. {% data reusables.webhooks.action_type_desc %} For more information, see "[About GitHub Sponsors](/sponsors/getting-started-with-github-sponsors/about-github-sponsors)". diff --git a/data/ui.yml b/data/ui.yml index 17425b6564d0..3cf1451c03c4 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -143,6 +143,7 @@ product_landing: code_examples: Code examples search_code_examples: Search code examples show_more: Show more + explore_people_and_projects: Explore people and projects sorry: Sorry, there is no result for no_example: It looks like we don't have an example that fits your filter. try_another: Try another filter or add your code example. @@ -150,6 +151,7 @@ product_landing: learn: Learn how to add a code example communities_using_discussions: Communities using discussions add_your_community: Add your community + sponsor_community: GitHub Sponsors community product_sublanding: start: Start start_path: Start path diff --git a/data/variables/sponsors_user_examples.yml b/data/variables/sponsors_user_examples.yml new file mode 100644 index 000000000000..6695ac0a588c --- /dev/null +++ b/data/variables/sponsors_user_examples.yml @@ -0,0 +1,19 @@ +# Images and descriptions are pulled directly from the repo + +- user: chaynHQ + description: Chayn helps women experiencing abuse find the right information and support they need to take control of their lives. + +- user: foosel + description: ๐Ÿ‘‹ I'm Gina, and I'm mostly known for being the creator and main developer of OctoPrint ๐Ÿ™. + +- user: dayhaysoos + description: What's up? I'm Nick. I'm an engineer who has a new-found passion for removing friction from the e-commerce developer experience. + +- user: yyx990803 + description: I'm working fulltime on Vue.js, a frontend JavaScript framework for building web applications, and Vite, a modern web build tool. + +- user: calebporzio + description: ๐Ÿšถโ€โ™‚๏ธI left my day job in Jan 2019 to pursue open-source. Since then, I've built Laravel Livewire, AlpineJS, and a bunch of other stuff. + +- user: kjaymiller + description: Hi Y'all I'm Jay! ๐Ÿ‘‹ I'm a Marine Corps Veteran turned developer that's been actively coding since 2014. I'm also involved in the productivity space where I can be found helping people with automations for some of their favorite apps and tools. diff --git a/includes/article-cards.html b/includes/article-cards.html index de7c3eb5ef03..362abacd1384 100644 --- a/includes/article-cards.html +++ b/includes/article-cards.html @@ -1,7 +1,10 @@ {% assign maxArticles = 9 %}
+ + {% if page.learningTracks %}

{% data ui.product_sublanding.all_guides %}

+ {% endif %}
@@ -39,9 +42,11 @@

{% data ui.product_sublanding.all_guides %}

{{ link_card | replace: "", card_display_class }} {% endfor %} + {% if page.includeGuides.length > maxArticles %} + {% endif %}

{% data ui.product_sublanding.no_result %}

diff --git a/includes/sponsor-examples.html b/includes/sponsor-examples.html new file mode 100644 index 000000000000..06a2ba6bd70b --- /dev/null +++ b/includes/sponsor-examples.html @@ -0,0 +1,9 @@ +
+

{% data ui.product_landing.sponsor_community %}

+ +
+ {% render sponsors-community-card for productUserExamples as example %} + +
+ {% data ui.product_landing.explore_people_and_projects %} {% octicon "arrow-right" %} +
diff --git a/includes/sponsors-community-card.html b/includes/sponsors-community-card.html new file mode 100644 index 000000000000..db00535a546d --- /dev/null +++ b/includes/sponsors-community-card.html @@ -0,0 +1,14 @@ + diff --git a/javascripts/filter-cards.js b/javascripts/filter-cards.js index b62c210556dd..e96b2790028a 100644 --- a/javascripts/filter-cards.js +++ b/javascripts/filter-cards.js @@ -19,10 +19,12 @@ export default function cardsFilter () { const showMoreButton = document.querySelector('.js-filter-card-show-more') const noResults = document.querySelector('.js-filter-card-no-results') // if jsFilterCardMax not set, assume no limit (well, at 99) - const maxCards = showMoreButton ? parseInt(showMoreButton.dataset.jsFilterCardMax || 99) : null + // some landing pages don't include the button because the number of + // guides is less than the max defined in includes/article-cards.html + const maxCards = showMoreButton ? parseInt(showMoreButton.dataset.jsFilterCardMax || 99) : 99 const noFilter = () => { - showMoreButton.classList.remove('d-none') + if (showMoreButton) showMoreButton.classList.remove('d-none') for (let index = 0; index < cards.length; index++) { const card = cards[index] // Hide all but the first n number of cards @@ -38,7 +40,7 @@ export default function cardsFilter () { const { currentTarget } = evt const value = currentTarget.value - showMoreButton.classList.add('d-none') + if (showMoreButton) showMoreButton.classList.add('d-none') // Track whether or not we had at least one match let hasMatches = false diff --git a/layouts/product-landing.html b/layouts/product-landing.html index de9e83368d38..618ec963ef1b 100644 --- a/layouts/product-landing.html +++ b/layouts/product-landing.html @@ -125,6 +125,10 @@

{{ link.title }} โ†’

{% include community-examples %} {% endif %} + {% if productUserExamples %} + {% include sponsor-examples %} + {% endif %} + {{ renderedPage }}
diff --git a/layouts/product-sublanding.html b/layouts/product-sublanding.html index 4c4dfe54a9c9..ad5e89476246 100644 --- a/layouts/product-sublanding.html +++ b/layouts/product-sublanding.html @@ -22,8 +22,9 @@

{% data ui.product_sublanding.guides %}

+ {% assign featuredTrack = page.learningTracks[0] %} + {% if featuredTrack %}
- {% assign featuredTrack = page.learningTracks[0] %}
  • @@ -54,7 +55,10 @@

    {{ guide.title }}

    + {% endif %} + {% assign learningTracks = page.learningTracks %} + {% if learningTracks %}

    {% data ui.product_sublanding.learning_paths %}

    {% data ui.product_sublanding.learning_paths_desc %}
    @@ -100,6 +104,7 @@
    {{ guide.title }}
    {% endfor %}
+ {% endif %}
diff --git a/lib/changelog.js b/lib/changelog.js index 81c83f452672..2e0541605ac7 100644 --- a/lib/changelog.js +++ b/lib/changelog.js @@ -32,7 +32,7 @@ async function getChangelogItems (prefix, feed) { // capitalize the first letter of the title title: title.trim().charAt(0).toUpperCase() + title.slice(1), date: item.isoDate, - href: item.guid + href: item.link } }) diff --git a/middleware/context.js b/middleware/context.js index 7ec21bb7884e..30081f2ec11d 100644 --- a/middleware/context.js +++ b/middleware/context.js @@ -54,6 +54,7 @@ module.exports = async function contextualize (req, res, next) { if (productMap[req.context.currentProduct]) { req.context.productCodeExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_code_examples`] req.context.productCommunityExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_community_examples`] + req.context.productUserExamples = req.context.site.data.variables[`${productMap[req.context.currentProduct].id}_user_examples`] } // JS + CSS asset paths