From 952122cde3a30d439979b809896e954af37737de Mon Sep 17 00:00:00 2001 From: Anthony Johnson Date: Tue, 18 Jan 2022 09:37:30 -0800 Subject: [PATCH 1/9] Only remove css/js paths in theme static path This was removing images as well, which we don't want. --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index fefe45e1..6e59207a 100644 --- a/package.json +++ b/package.json @@ -5,7 +5,7 @@ "main": "src/js/index.js", "scripts": { "clean": "npm run clean-assets && npm run clean-html", - "clean-assets": "rm -rfv readthedocs-theme/static/*; exit 0", + "clean-assets": "rm -rfv readthedocs-theme/static/{css,js}; exit 0", "clean-html": "rm -rfv output/*; exit 0", "build": "npm run build-assets && npm run build-html", "build-assets": "npm run clean-assets && webpack --mode=production --progress --colors", From 6eb7ad024ed7d95fd515906d7a8c056629326273 Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Thu, 20 Jan 2022 17:12:06 +0000 Subject: [PATCH 2/9] Add pricing template --- content/pages/pricing.md | 5 + .../templates/readthedocs/pricing.html | 504 ++++++++++++++++++ 2 files changed, 509 insertions(+) create mode 100644 content/pages/pricing.md create mode 100644 readthedocs-theme/templates/readthedocs/pricing.html diff --git a/content/pages/pricing.md b/content/pages/pricing.md new file mode 100644 index 00000000..fb301a48 --- /dev/null +++ b/content/pages/pricing.md @@ -0,0 +1,5 @@ +title: Read the Docs - Pricing +template: readthedocs/pricing +save_as: pricing.html +status: hidden +description: Read the Docs - Pricing diff --git a/readthedocs-theme/templates/readthedocs/pricing.html b/readthedocs-theme/templates/readthedocs/pricing.html new file mode 100644 index 00000000..0648a98b --- /dev/null +++ b/readthedocs-theme/templates/readthedocs/pricing.html @@ -0,0 +1,504 @@ +{% extends "page.html" %} + +{% block body_id %}pricing{% endblock %} + +{% block content %} + + +
+
+ +
+
+ Read the Docs +
+

+ for Business +

+
+ +
+ + +
+ +
+ +
Basic
+ +
$50
+
+ per month +
+ + + +
+ +
+
+
+
Automatic build
+
on every commit
+
+
+
+
+
Multi-version handling
+
from branches or tags
+
+
+
+
+
Downloadable formats
+
PDF, HTML
+
+
+
+
+
Enhanced full-text search
+
+
+
+
+
API access
+
+
+
+
+
Unlimited projects & users
+
+
+
+
+
Private Versions
+
+
+
+
+
Live PR preview
+
Live preview of all pull requests
+
+
+
+
+
Email build failure notifications
+
+
+
+
+
2 day support response time
+
+
+
+
+
2 Concurrent builds
+
+
+
+ +
+
+
+ + + +
+ +
+ +
Advanced
+ +
$150
+
+ per month +
+ + + +
+ +
+
+
+
All the features from the Basic plan
+
+
+
+
+
4 Concurrent builds
+
+
+
+
+
Custom domain
+
+
+
+
+
Content embedding
+
+
+
+
+
Search term analytics
+
30 days
+
+
+
+
+
Pageview analytics
+
30 days
+
+
+
+ +
+
+
+ + + +
+ +
+ +
Pro
+ +
$250
+
+ per month +
+ + + +
+ +
+
+
+
All the features from the Advanced plan
+
+
+
+
+
1 day support response time
+
+
+
+
+
6 Concurrent builds
+
+
+
+
+
Search term analytics
+
90 days
+
+
+
+
+
Pageview analytics
+
90 days
+
+
+
+
+
Auth auditing
+
90 days
+
+
+
+
+
Single sign-on (SSO)
+
with Google
+
+
+
+ +
+
+
+ + +
+ +
+
+ Base Plans +
+
+ +
+ + +
+ +
+ +
Base
+ +
Open Source
+
+ forever free +
+ + + +
+ +
+
+
+
Automatic build
+
on every commit
+
+
+
+
+
Multi-version handling
+
from branches or tags
+
+
+
+
+
Downloadable formats
+
PDF, HTML
+
+
+
+
+
Enhanced full-text search
+
+
+
+ +
+
+
+ + + +
+ +
+ +
Ad-free
+ +
from $5
+
+ one-time donation + limited time +
+ + + +
+ +
+
+
+
Automatic build
+
on every commit
+
+
+
+
+
Multi-version handling
+
from branches or tags
+
+
+
+
+
Downloadable formats
+
PDF, HTML
+
+
+
+
+
Enhanced full-text search
+
+
+
+
+
Ad-free user
+
stop seeing ads on any Read the Docs hosted documentation when logged in your account
+
+
+
+ +
+
+
+ + + +
+ +
+ +
Gold
+ +
from $5
+
+ per month +
+ + + +
+ +
+
+
+
Automatic build
+
on every commit
+
+
+
+
+
Multi-version handling
+
from branches or tags
+
+
+
+
+
Downloadable formats
+
PDF, HTML
+
+
+
+
+
Enhanced full-text search
+
+
+
+
+
Ad-free user
+
stop seeing ads on any Read the Docs hosted documentation when logged in your account
+
+
+
+
+
Ad-free documentation
+
stop showing ads to all your users on your Read the Docs hosted documentation
+
+
+
+ +
+
+
+ + +
+ +
+
+ + + +
+
+ +
+ +
+
+ +

About our plans

+

+ Our plans are divided in two main types: the Community and the Enterprise plans. +

+

+ The Community plans are meant for open source projects and do not allow private repositories or documentation. Here we have the base free plan and the gold plan. Additionally, the base plan will allow for donations to be made that will turn it into an Ad-free plan for a limited time, dependant on the donation amount and recurrence. +

+ +
+
+ +
+ + +
+

Enterprise plans

+

+ Offer flexible options for your organizations, whether hosting public or private documentation. +

+
+ + +
+
+ +
+

 

+

Additional features

+

+ For enterprise documentation needs not met by our other plans, we can offer customized plans with additional services. These include: +

+
    +
  • IP address allow lists to ensure only VPN users have access to your content
    • +
  • SLA-guaranteed support response times and documentation uptime
    • +
  • Unlimited audit tracking and analytics storage duration
    • +
  • Custom build requirements (additional memory, custom architectures)
    • +
+

+ We are happy to work with you on any additional requests you might have. Reach out with your specific needs. +

+

+ Still Have Questions? Contact us +

+
+ +
+

FAQ

+
+
Who can access my private documentation?
+

+ Private documentation can only be accessed by users you specify. Those users will need to log in and be authorized to view your documentation or you can share documentation with a private link for more limited access. +

+
+
+
Can I host documentation publicly?
+

+ Yes, projects and project versions can both be made public. Public documentation does not require a login for access. +

+
+
+
How does this differ from hosting on your community site?
+

+ The biggest advantages over our community site are the ability to create documentation from private repositories, significantly increased build resources for faster and larger builds, and priority support. +

+
+
+ +
+

 

+
+
Can you build documentation from private repositories?
+

+ Yes. We can build your documentation on every commit to your private repositories hosted on GitHub, BitBucket, or GitLab. +

+
+
+
Can you support a custom configuration for our company?
+

+ Absolutely! We support additional features, such as CDN support for public documentation, SSL support on your own domain, and can provide a number of services to help your company improve your documentation. Contact us for more information. +

+
+
+
Do you support annual pricing or purchase orders?
+

+ Yes, we are happy to offer annual pricing on all our plans at the end of your trial. Annual plans are allowed to be paid by purchase order and invoice. Monthly plans must be paid via credit card. +

+
+
+ +
+
+ +
+
+ +{% endblock content %} From 4050972fc282710087bf94a0185f2c3a7c4ef71b Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Mon, 24 Jan 2022 10:06:12 +0000 Subject: [PATCH 3/9] Apply suggestions from code review Co-authored-by: Anthony --- .../templates/readthedocs/pricing.html | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/readthedocs-theme/templates/readthedocs/pricing.html b/readthedocs-theme/templates/readthedocs/pricing.html index 0648a98b..1f89053d 100644 --- a/readthedocs-theme/templates/readthedocs/pricing.html +++ b/readthedocs-theme/templates/readthedocs/pricing.html @@ -31,14 +31,14 @@

per month - +
-
Automatic build
+
Automatic building
on every commit
@@ -50,8 +50,8 @@

-
Downloadable formats
-
PDF, HTML
+
Multiple formats
+
HTML, PDF, and EPUB
@@ -131,7 +131,7 @@

-
Custom domain
+
Custom domains
@@ -243,14 +243,14 @@

forever free

- +
-
Automatic build
+
Automatic building
on every commit
@@ -262,8 +262,8 @@

-
Downloadable formats
-
PDF, HTML
+
Multiple formats
+
HTML, PDF, and EPUB
@@ -438,9 +438,9 @@

Additional features

For enterprise documentation needs not met by our other plans, we can offer customized plans with additional services. These include:

    -
  • IP address allow lists to ensure only VPN users have access to your content
  • SLA-guaranteed support response times and documentation uptime
  • Unlimited audit tracking and analytics storage duration
    • +
  • IP address allow lists to ensure only VPN users have access to your content
  • Custom build requirements (additional memory, custom architectures)

@@ -478,7 +478,7 @@

 

Can you build documentation from private repositories?

- Yes. We can build your documentation on every commit to your private repositories hosted on GitHub, BitBucket, or GitLab. + Yes. We can build your documentation on every commit to your private repositories hosted on GitHub, Bitbucket, or GitLab.

From 41dcffdde613f3d03775c407bfa83993c443fe66 Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Mon, 24 Jan 2022 17:20:55 +0000 Subject: [PATCH 4/9] Rework base plans tables --- .../templates/readthedocs/pricing.html | 46 +------------------ 1 file changed, 2 insertions(+), 44 deletions(-) diff --git a/readthedocs-theme/templates/readthedocs/pricing.html b/readthedocs-theme/templates/readthedocs/pricing.html index 1f89053d..f58f7d24 100644 --- a/readthedocs-theme/templates/readthedocs/pricing.html +++ b/readthedocs-theme/templates/readthedocs/pricing.html @@ -298,31 +298,7 @@

-
Automatic build
-
on every commit
-
-
-
-
-
Multi-version handling
-
from branches or tags
-
-
-
-
-
Downloadable formats
-
PDF, HTML
-
-
-
-
-
Enhanced full-text search
-
-
-
-
-
Ad-free user
-
stop seeing ads on any Read the Docs hosted documentation when logged in your account
+
Upgrade to an Ad-free user, for a limited period of time, with all the features from the open source plan
@@ -351,25 +327,7 @@

-
Automatic build
-
on every commit
-
-
-
-
-
Multi-version handling
-
from branches or tags
-
-
-
-
-
Downloadable formats
-
PDF, HTML
-
-
-
-
-
Enhanced full-text search
+
All the features from the Advanced plan
From 44ae0ac72dfe365e3cc32c20502c7cecea5ab530 Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Mon, 24 Jan 2022 18:50:36 +0000 Subject: [PATCH 5/9] Update pricing.md contents --- content/pages/pricing.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/content/pages/pricing.md b/content/pages/pricing.md index fb301a48..5adab29d 100644 --- a/content/pages/pricing.md +++ b/content/pages/pricing.md @@ -1,5 +1,6 @@ -title: Read the Docs - Pricing +title: Pricing +subtitle: template: readthedocs/pricing save_as: pricing.html status: hidden -description: Read the Docs - Pricing +description: Read the docs pricing plans. From 5f1af9ca2b0a2268bd69de27296d5f2681bb116a Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Tue, 25 Jan 2022 09:27:26 +0000 Subject: [PATCH 6/9] Update contact link Co-authored-by: Anthony --- readthedocs-theme/templates/readthedocs/pricing.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/readthedocs-theme/templates/readthedocs/pricing.html b/readthedocs-theme/templates/readthedocs/pricing.html index f58f7d24..5e3d5fa3 100644 --- a/readthedocs-theme/templates/readthedocs/pricing.html +++ b/readthedocs-theme/templates/readthedocs/pricing.html @@ -405,7 +405,7 @@

Additional features

We are happy to work with you on any additional requests you might have. Reach out with your specific needs.

- Still Have Questions? Contact us + Still Have Questions? Contact us

From 489fa1c3d035b03f672aef50d15cbd81a9db2771 Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Tue, 25 Jan 2022 10:12:38 +0000 Subject: [PATCH 7/9] Reorder pricing card items --- .../templates/readthedocs/pricing.html | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/readthedocs-theme/templates/readthedocs/pricing.html b/readthedocs-theme/templates/readthedocs/pricing.html index 5e3d5fa3..52034d04 100644 --- a/readthedocs-theme/templates/readthedocs/pricing.html +++ b/readthedocs-theme/templates/readthedocs/pricing.html @@ -50,34 +50,34 @@

-
Multiple formats
-
HTML, PDF, and EPUB
+
Private Versions
-
Enhanced full-text search
+
Live PR preview
+
Live preview of all pull requests
-
API access
+
Unlimited projects & users
-
Unlimited projects & users
+
API access
-
Private Versions
+
Enhanced full-text search
-
Live PR preview
-
Live preview of all pull requests
+
Multiple formats
+
HTML, PDF, and EPUB
@@ -262,13 +262,13 @@

-
Multiple formats
-
HTML, PDF, and EPUB
+
Enhanced full-text search
-
Enhanced full-text search
+
Multiple formats
+
HTML, PDF, and EPUB

From bf5f64202a1318ac46dcc2b390b13b97de45fca9 Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Mon, 31 Jan 2022 08:53:46 +0000 Subject: [PATCH 8/9] Apply suggestions from code review Co-authored-by: Anthony --- readthedocs-theme/templates/readthedocs/pricing.html | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/readthedocs-theme/templates/readthedocs/pricing.html b/readthedocs-theme/templates/readthedocs/pricing.html index 52034d04..a8027150 100644 --- a/readthedocs-theme/templates/readthedocs/pricing.html +++ b/readthedocs-theme/templates/readthedocs/pricing.html @@ -114,7 +114,7 @@

per month

- +
@@ -170,7 +170,7 @@

per month

- +
@@ -320,7 +320,7 @@

per month

- +
@@ -339,7 +339,7 @@

Ad-free documentation
-
stop showing ads to all your users on your Read the Docs hosted documentation
+
stop showing ads to readers on hosted documentation

From 3a673c9660e20d06360fd29765eedeeea4cd67a0 Mon Sep 17 00:00:00 2001 From: Ana Costa Date: Mon, 31 Jan 2022 09:50:43 +0000 Subject: [PATCH 9/9] Rework intro section --- .../templates/readthedocs/pricing.html | 88 ++----------------- 1 file changed, 5 insertions(+), 83 deletions(-) diff --git a/readthedocs-theme/templates/readthedocs/pricing.html b/readthedocs-theme/templates/readthedocs/pricing.html index a8027150..d662585a 100644 --- a/readthedocs-theme/templates/readthedocs/pricing.html +++ b/readthedocs-theme/templates/readthedocs/pricing.html @@ -362,14 +362,11 @@

-
+
-

About our plans

+

About our platforms

- Our plans are divided in two main types: the Community and the Enterprise plans. -

-

- The Community plans are meant for open source projects and do not allow private repositories or documentation. Here we have the base free plan and the gold plan. Additionally, the base plan will allow for donations to be made that will turn it into an Ad-free plan for a limited time, dependant on the donation amount and recurrence. + A question our users often have is what the difference is between Read the Docs Community and Read the Docs for Business. The features available on both platforms are the same. The primary difference is the audience and use cases that are supported.

@@ -377,83 +374,8 @@

About our plans

- -
-

Enterprise plans

-

- Offer flexible options for your organizations, whether hosting public or private documentation. -

-
- - -
-
- -
-

 

-

Additional features

-

- For enterprise documentation needs not met by our other plans, we can offer customized plans with additional services. These include: -

-
    -
  • SLA-guaranteed support response times and documentation uptime
    • -
  • Unlimited audit tracking and analytics storage duration
    • -
  • IP address allow lists to ensure only VPN users have access to your content
    • -
  • Custom build requirements (additional memory, custom architectures)
    • -
-

- We are happy to work with you on any additional requests you might have. Reach out with your specific needs. -

-

- Still Have Questions? Contact us -

-
- -
-

FAQ

-
-
Who can access my private documentation?
-

- Private documentation can only be accessed by users you specify. Those users will need to log in and be authorized to view your documentation or you can share documentation with a private link for more limited access. -

-
-
-
Can I host documentation publicly?
-

- Yes, projects and project versions can both be made public. Public documentation does not require a login for access. -

-
-
-
How does this differ from hosting on your community site?
-

- The biggest advantages over our community site are the ability to create documentation from private repositories, significantly increased build resources for faster and larger builds, and priority support. -

-
-
- -
-

 

-
-
Can you build documentation from private repositories?
-

- Yes. We can build your documentation on every commit to your private repositories hosted on GitHub, Bitbucket, or GitLab. -

-
-
-
Can you support a custom configuration for our company?
-

- Absolutely! We support additional features, such as CDN support for public documentation, SSL support on your own domain, and can provide a number of services to help your company improve your documentation. Contact us for more information. -

-
-
-
Do you support annual pricing or purchase orders?
-

- Yes, we are happy to offer annual pricing on all our plans at the end of your trial. Annual plans are allowed to be paid by purchase order and invoice. Monthly plans must be paid via credit card. -

-
-
- -
+
+ Choosing between our two sites