Various documentation updates; Sponsorship notes

motaz-hejaze · Nov 16, 2020 · acebc4a · acebc4a
1 parent b470228
commit acebc4a
Show file tree

Hide file tree

Showing 11 changed files with 107 additions and 67 deletions.
diff --git a/HISTORY.md b/HISTORY.md
@@ -13,8 +13,8 @@
     **Settings changes: Introduction of `DJSTRIPE_FOREIGN_KEY_TO_FIELD`**
 
     You are required to set this new setting in 2.4.0.
-    For more information, checkout
-    [settings](https://dj-stripe.readthedocs.io/en/latest/reference/settings.html).
+    For more information, see
+    [settings](https://dj-stripe.readthedocs.io/en/latest/reference/settings/).
 
 -   Support Django 3.1.
 
@@ -25,14 +25,15 @@
 -   Support multi-item subscriptions.
 
 -   Support for API keys in the database.
-    Check [API keys](https://dj-stripe.readthedocs.io/en/latest/api_keys.html).
+    Check [API keys](https://dj-stripe.readthedocs.io/en/latest/api_keys/).
 
 -   Support for multiple Stripe accounts.
 
 -   Add DJSTRIPE_USE_NATIVE_JSONFIELD setting to use Django 3.1 native
     JSONField over django-jsonfield.
 
 -   Add support for Reporting categories, TaxIds and the following fields:
+
     -   `BalanceTransaction.source`
     -   `InvoiceItem.unit_amount`
     -   `InvoiceItem.unit_amount_decimal`
@@ -41,7 +42,7 @@
     -   `SubscriptionItem.billing_thresholds`
     -   `SubscriptionSchedule.billing_thresholds`
     -   `alipay_account` in `DjstripePaymentMethodType`
-    and updated the following models:
+        and updated the following models:
     -   `Charge`
     -   `FileUploadPurpose`
     -   `SourceTypes`
@@ -53,9 +54,10 @@
 -   Rename PlanBillingScheme to BillingScheme.
 
 -   Remove `Plan.update_name()` and these previously-deprecated fields:
-    - `Customer.business_vat_id`
-    - `Subscription.start`
-    - `Subscription.billing`
+
+    -   `Customer.business_vat_id`
+    -   `Subscription.start`
+    -   `Subscription.billing`
 
 -   Increase minimum stripe-python version to 2.48.0.
 
@@ -387,10 +389,8 @@ Changes from API 2019-03-14:
 
 ### Squashed dev migrations
 
-As per our [migration
-policy](https://dj-stripe.readthedocs.io/en/latest/project/contributing.html#squash-of-unreleased-migrations-on-master)
-unreleased migrations on the master branch (migration numbers &gt;=0004)
-have been squashed.
+As per our [migration policy](contributing.md), unreleased migrations on the master
+branch have been squashed.
 
 If you have been using the 2.1.0dev branch from master, you'll need to
 run the squashed migrations migrations before upgrading to &gt;=2.1.0.

diff --git a/README.md b/README.md
@@ -86,6 +86,8 @@ Assuming the tests are run against PostgreSQL:
 
 # Funding this project
 
+[![Stripe Logo](../logos/stripe_blurple.svg)](https://stripe.com)
+
 You can now become a sponsor to dj-stripe with [GitHub Sponsors](https://github.com/sponsors/dj-stripe).
 
 We've been bringing dj-stripe to the world for over 7 years and are excited to be able to start

diff --git a/docs/index.md b/docs/index.md
@@ -1,24 +1,45 @@
-# Django + Stripe Made Easy
-
--   Subscription management
--   Designed for easy implementation of post-registration subscription
-    forms
--   Single-unit purchases
--   Works with Django &gt;= 2.2
--   Works with Python &gt;= 3.6
--   Built-in migrations
--   Dead-Easy installation
--   Leverages the best of the 3rd party Django package ecosystem
--   `djstripe` namespace so you can have
-    more than one payments related app
--   Documented
--   100% Tested
-
-# Constraints
-
-1.  For stripe.com only
-2.  Only use or support well-maintained third-party libraries
-3.  For modern Python and Django
+# dj-stripe - Django + Stripe Made Easy
+
+## Introduction
+
+dj-stripe implements all of the Stripe models, for Django. Set up your
+webhook endpoint and start receiving model updates. You will then have
+a copy of all the Stripe models available in Django models, as soon as
+they are updated!
+
+The full documentation is available [on Read the Docs](https://dj-stripe.readthedocs.io/).
+
+## Features
+
+-   Stripe Core
+-   Stripe Billing
+-   Stripe Cards (JS v2) and Sources (JS v3)
+-   Payment Methods and Payment Intents (SCA support)
+-   Support for multiple accounts and API keys
+-   Stripe Connect (partial support)
+-   Tested with Stripe API `2020-08-27` (see [API versions](api_versions.md))
+
+## Funding and Support
+
+You can now become a sponsor to dj-stripe with [GitHub Sponsors](https://github.com/sponsors/dj-stripe).
+
+If you use dj-stripe commercially, we would encourage you to invest in its continued
+development by [signing up for a paid plan](https://github.com/sponsors/dj-stripe).
+Corporate sponsors [receive priority support and development time](project/support.md).
+
+All contributions through GitHub sponsors flow into our
+[Open Collective](https://opencollective.com/dj-stripe), which holds our funds and keeps
+an open ledger on how donations are spent.
+
+### Our Gold sponsors
+
+<style>
+img[alt="Stripe Logo"] {
+    max-width: 250px;
+}
+</style>
+
+[![Stripe Logo](../logos/stripe_blurple.svg)](https://stripe.com)
 
 <!--
 AUTODOC SETUP: Do not remove the piece of code below.

diff --git a/docs/installation.md b/docs/installation.md
@@ -40,8 +40,8 @@ Run the commands:
 
     python manage.py djstripe_sync_models
 
-See <https://dj-stripe.readthedocs.io/en/latest/stripe_elements_js.html>
-for notes about usage of the Stripe Elements frontend JS library.
+See [here](stripe_elements_js.md) for notes about usage of the Stripe Elements
+frontend JS library.
 
 ## Running Tests
 

diff --git a/docs/logos/stripe_blurple.svg b/docs/logos/stripe_blurple.svg
diff --git a/docs/project/sponsors.md b/docs/project/sponsors.md
@@ -0,0 +1,17 @@
+# Sponsors
+
+## Gold Sponsors
+
+[![Stripe Logo](../logos/stripe_blurple.svg)](https://stripe.com)
+
+This project is sponsored by none other than [Stripe](https://stripe.com/),
+since August 2020.
+
+We're thankful for their contribution, which has allowed us to greatly improve the
+project, increase QA and testing, and push forward with the dj-stripe 2.4.0 release.
+
+## Silver Sponsors
+
+We do not currently have any Silver sponsors.
+
+[Want to be the first?](https://github.com/sponsors/dj-stripe)
diff --git a/docs/usage/checking_customer_subscription.md b/docs/usage/checking_customer_subscription.md
diff --git a/docs/usage/creating_invoices.md b/docs/usage/creating_invoices.md
diff --git a/docs/usage/one_off_charges.md b/docs/usage/one_off_charges.md
diff --git a/docs/usage/running_reports.md b/docs/usage/running_reports.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -18,22 +18,26 @@ markdown_extensions:
 
 nav:
   - Home: index.md
+  - Sponsors: project/sponsors.md
   - Getting Started:
     - Installation: installation.md
-    - A note on Stripe API keys: api_keys.md
+    - Setting your API keys: api_keys.md
     - A note on Stripe API Versions: api_versions.md
     - A note on Stripe Stripe Elements JS methods: stripe_elements_js.md
   - Usage:
-    - Checking if a customer has a subscription: usage/checking_customer_subscription.md
     - Subscribing a customer to a plan: usage/subscribing_customers.md
-    - Creating a one-off charge for a customer: usage/one_off_charges.md
     - Restricting access to only active subscribers: usage/restricting_access.md
     - Managing subscriptions and payment sources: usage/managing_subscriptions.md
-    - Creating invoices: usage/creating_invoices.md
-    - Running reports: usage/running_reports.md
     - Webhooks: usage/webhooks.md
     - Manually syncing data with Stripe: usage/manually_syncing_with_stripe.md
     - Cookbook: usage/cookbook.md
+  - Project:
+    - Changelog: project/history.md
+    - Contributing: project/contributing.md
+    - Test Fixtures: project/test_fixtures.md
+    - Credits: project/authors.md
+    - Support: project/support.md
+    - Release Process: project/release_process.md
   - Reference:
     - Context Managers: reference/context_managers.md
     - Decorators: reference/decorators.md
@@ -43,10 +47,3 @@ nav:
     - Models: reference/models.md
     - Settings: reference/settings.md
     - Utilities: reference/utils.md
-  - Project:
-    - Contributing: project/contributing.md
-    - Test Fixtures: project/test_fixtures.md
-    - Credits: project/authors.md
-    - History: project/history.md
-    - Support: project/support.md
-    - Release Process: project/release_process.md