From 1adcc0231a8888f7b775ad15dea36f263247e64e Mon Sep 17 00:00:00 2001 From: squidfunk Date: Sun, 30 May 2021 11:45:36 +0200 Subject: [PATCH] Updated Insiders documentation --- docs/insiders/index.md | 58 +++++++++++++++++++++++++++--------------- 1 file changed, 38 insertions(+), 20 deletions(-) diff --git a/docs/insiders/index.md b/docs/insiders/index.md index 5f38b7c37..1cf96f74a 100644 --- a/docs/insiders/index.md +++ b/docs/insiders/index.md @@ -28,8 +28,8 @@ A demo is worth a thousand words — check it out at ## How sponsorship works -New features first land in Insiders, which means that _sponsors will have access -immediately_. Every feature is tied to a funding goal in monthly subscriptions. +New features first land in Insiders, so _eligible sponsors have immediate +access_. Every feature is tied to a funding goal in monthly subscriptions. When a funding goal is hit, the features that are tied to it are merged back into Material for MkDocs and released for general availability. Bugfixes are always released simultaneously in both editions.[^1] @@ -55,18 +55,25 @@ currently only available to sponsors._ ## How to become a sponsor -You can become a sponsor using your individual or organization's GitHub account. -Just visit __[squidfunk's sponsor profile][5]__, pick any tier __from -$10/month__, and complete the checkout. Then, after a few hours, @squidfunk will -add you as a collaborator to the super-secret private GitHub repositority +You can become an eligible sponsor with your individual or organization's GitHub +account. Visit __[squidfunk's sponsor profile][5]__, pick any tier __from +$10/month__[^2], and complete the checkout. Then, after a few hours, @squidfunk +will add you as a collaborator to the super-secret private GitHub repositority containing the Insiders edition, which contains all [brand new and exclusive features][4]. __Important__: If you're sponsoring @squidfunk through a GitHub organization, please send a short email to sponsors@squidfunk.com with the name of your -organization and the account that should be added as a collaborator.[^2] +organization and the account that should be added as a collaborator.[^3] + +You can cancel your sponsorship anytime.[^4] [^2]: + Note that $10/month is the minimum amount to become eligible for Insiders. + If you sponsor with a lower amount, it's still very much apprecaited, but + you won't be granted access to Insiders. Custom amounts of $10+ are also eligible. + + [^3]: It's currently not possible to grant access to each member of an organization, as GitHub only allows for adding users. Thus, after sponsoring, please send an email to sponsors@squidfunk.com, stating which @@ -79,16 +86,14 @@ organization and the account that should be added as a collaborator.[^2] private Insiders GitHub repository, and grant access to all members of the organizations. -You can cancel your sponsorship anytime.[^3] - - [^3]: + [^4]: If you cancel your sponsorship, GitHub schedules a cancellation request - which will become effective at the end of the billing cycle, which ends at - the 22nd of a month for monthly sponsorships. This means that even though - you cancel your sponsorship, you will keep your access to Insiders as long - as your cancellation isn't effective. All charges are processed by GitHub - through Stripe. As we don't receive any information regarding your payment, - and GitHub doesn't offer refunds, sponsorships are non-refundable. + which will become effective at the end of the billing cycle. This means + that even though you cancel your sponsorship, you will keep your access to + Insiders as long as your cancellation isn't effective. All charges are + processed by GitHub through Stripe. As we don't receive any information + regarding your payment, and GitHub doesn't offer refunds, sponsorships are + non-refundable. [:octicons-heart-fill-24:{ .mdx-heart }   Join our awesome sponsors][5]{ .md-button .md-button--primary .mdx-sponsorship-button } @@ -272,6 +277,19 @@ your `GH_TOKEN` to users. [34]: ../publishing-your-site.md#github-pages +### Payment + +_We don't want to pay for sponsorship every month. Are there any other options?_ + +Yes. You can sponsor on a yearly basis by [switching your GitHub account to a +yearly billing cycle][35]. If for some reason you cannot do that, you could +also create a dedicated GitHub account with a yearly billing cycle, which you +only use for sponsoring (some sponsors already do that). + +One-time payments are not eligible for Insiders. + + [35]: https://docs.github.com/en/github/setting-up-and-managing-billing-and-payments-on-github/changing-the-duration-of-your-billing-cycle + ### Terms _We're using Material for MkDocs to build the developer documentation of a @@ -279,7 +297,7 @@ commercial project. Can we use Insiders under the same terms and conditions?_ Yes. Whether you're an individual or a company, you may use _Material for MkDocs Insiders_ precisely under the same terms as Material for MkDocs, which are given -by the [MIT license][35]. However, we kindly ask you to respect the following +by the [MIT license][36]. However, we kindly ask you to respect the following guidelines: - Please __don't distribute the source code__ of Insiders. You may freely use @@ -290,7 +308,7 @@ guidelines: - If you cancel your subscription, you're removed as a collaborator and will miss out on future updates of Insiders. However, you may __use the latest version__ that's available to you __as long as you like__. Just remember that - [GitHub deletes private forks][36]. + [GitHub deletes private forks][37]. - [35]: ../license.md - [36]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository + [36]: ../license.md + [37]: https://docs.github.com/en/github/setting-up-and-managing-your-github-user-account/removing-a-collaborator-from-a-personal-repository