Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Copy updates for intro pages #11948

Merged
merged 7 commits into from
Feb 4, 2025
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
More tweaks
ericholscher committed Jan 23, 2025
commit dbf5e06f35951bfee5c232d0e97fcfebefd85535
2 changes: 1 addition & 1 deletion docs/user/commercial/index.rst
Original file line number Diff line number Diff line change
@@ -37,7 +37,7 @@ Advertising-free

Business features
Enjoy additional functionality specifically for larger organizations such as
team management, single-sign on, and audit logging.
team management, single sign-on, and audit logging.

.. seealso::

4 changes: 2 additions & 2 deletions docs/user/commercial/organizations.rst
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@ The best way to think about this relationship is:

.. warning::

Owners, Members and Teams behave differently if you are using
Owners, Members, and Teams behave differently if you are using
:ref:`sso_git_provider`.

Team types
@@ -40,7 +40,7 @@ Example
~~~~~~~

ACME would set up *Owners* of their organization,
for example Frank Roadrunner would be an owner.
for example, Frank Roadrunner would be an owner.
He has full access to the organization and all projects.

Wile E. Coyote is a contractor,
2 changes: 1 addition & 1 deletion docs/user/commercial/privacy-level.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Privacy Levels
Privacy levels
--------------

.. include:: /shared/admonition-rtd-business.rst
9 changes: 4 additions & 5 deletions docs/user/commercial/sharing.rst
Original file line number Diff line number Diff line change
@@ -20,7 +20,7 @@ Creating a shared item
* Select access type (secret link, password, or HTTP header token),
add an expiration date and a *Description* to help with managing access in the future.
* Check ``Allow access to all versions?`` if you want to grant access to all versions,
or uncheck that option and select the specific versions you want grant access to.
or uncheck that option and select the specific versions you want to grant access to.
* Click :guilabel:`Save`.
* Get the info needed to share your documentation with other users:

@@ -32,7 +32,7 @@ Creating a shared item

.. note::

You can always revoke access by removing the sharing item in this page.
You can always revoke access by removing the sharing item on this page.

Sharing methods
---------------
@@ -93,12 +93,11 @@ For example:

curl --url https://docs.example.com/en/latest/example.html --user '$TOKEN:'


Typical sharing configurations
------------------------------

There are a few common ways to architect sharing,
with trade offs between them,
with trade-offs between them,
and you should choose the one that best fits your use case.

Bulk passwords
@@ -132,7 +131,7 @@ If you want a more transparent experience for your users,
you can create a proxy that authenticates users against your system,
and then proxies the request to Read the Docs.
This is more complex to set up,
but will allow users to access the documentation directly from a bookmark,
but will allow users to access the documentation directly from a bookmark.

This approach would use a :ref:`commercial/sharing:HTTP Authorization Header` to authenticate users,
and would be configured in your proxy server.
6 changes: 3 additions & 3 deletions docs/user/commercial/subscriptions.rst
Original file line number Diff line number Diff line change
@@ -10,7 +10,7 @@ It's easy to achieve a number of common tasks in this dashboard:
* View, download, and pay invoices.
* Add additional tax (VAT/EIN) or contact email addresses on your invoices.

You can always find our most up to date pricing information on our `pricing page <https://about.readthedocs.com/pricing/>`_.
You can always find our most up-to-date pricing information on our `pricing page <https://about.readthedocs.com/pricing/>`_.

Managing your subscription
--------------------------
@@ -32,7 +32,7 @@ Cancelling your subscription can be done following the instructions in `Managing
Your subscription will remain active for the remainder of the current billing period,
and will not renew for the next billing period.

**We can not cancel subscriptions through an email request,
**We cannot cancel subscriptions through an email request,
as email is an insecure method of verifying a user's identity.**
If you email us about this,
we require you to verify your identity by logging into your Read the Docs account and submitting an official support request there.
@@ -65,5 +65,5 @@ is generally where we recommend most academic projects to host their projects.
If you have constraints on how public your documentation can be,
our commercial hosting is probably a better fit.

We offer a 50% discount on our all of our commercial plans to certified academic and non-profit organizations.
We offer a 50% discount on all of our commercial plans to certified academic and non-profit organizations.
Please contact :doc:`/support` to request this discount.