Skip to content

Commit 6288a3b

Browse files
Copy updates for intro pages (#11948)
<!-- readthedocs-preview docs start --> --- :books: Documentation previews :books: - User's documentation (`docs`): https://docs--11948.org.readthedocs.build/en/11948/ <!-- readthedocs-preview docs end --> <!-- readthedocs-preview dev start --> - Developer's documentation (`dev`): https://dev--11948.org.readthedocs.build/en/11948/ <!-- readthedocs-preview dev end --> --------- Co-authored-by: Manuel Kaufmann <[email protected]>
1 parent 84daacd commit 6288a3b

21 files changed

+93
-109
lines changed

docs/user/commercial/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Advertising-free
3737

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

4242
.. seealso::
4343

docs/user/commercial/organizations.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The best way to think about this relationship is:
2525

2626
.. warning::
2727

28-
Owners, Members and Teams behave differently if you are using
28+
Owners, Members, and Teams behave differently if you are using
2929
:ref:`sso_git_provider`.
3030

3131
Team types
@@ -40,7 +40,7 @@ Example
4040
~~~~~~~
4141

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

4646
Wile E. Coyote is a contractor,

docs/user/commercial/privacy-level.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Privacy Levels
1+
Privacy levels
22
--------------
33

44
.. include:: /shared/admonition-rtd-business.rst

docs/user/commercial/sharing.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Creating a shared item
2020
* Select access type (secret link, password, or HTTP header token),
2121
add an expiration date and a *Description* to help with managing access in the future.
2222
* Check ``Allow access to all versions?`` if you want to grant access to all versions,
23-
or uncheck that option and select the specific versions you want grant access to.
23+
or uncheck that option and select the specific versions you want to grant access to.
2424
* Click :guilabel:`Save`.
2525
* Get the info needed to share your documentation with other users:
2626

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

3333
.. note::
3434

35-
You can always revoke access by removing the sharing item in this page.
35+
You can always revoke access by removing the sharing item on this page.
3636

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

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

96-
9796
Typical sharing configurations
9897
------------------------------
9998

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

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

137136
This approach would use a :ref:`commercial/sharing:HTTP Authorization Header` to authenticate users,
138137
and would be configured in your proxy server.

docs/user/commercial/subscriptions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ It's easy to achieve a number of common tasks in this dashboard:
1010
* View, download, and pay invoices.
1111
* Add additional tax (VAT/EIN) or contact email addresses on your invoices.
1212

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

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

35-
**We can not cancel subscriptions through an email request,
35+
**We cannot cancel subscriptions through an email request,
3636
as email is an insecure method of verifying a user's identity.**
3737
If you email us about this,
3838
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.
6565
If you have constraints on how public your documentation can be,
6666
our commercial hosting is probably a better fit.
6767

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

docs/user/intro/accounts.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Account authentication methods
44
Read the Docs supports several authentication methods for creating an account and logging in.
55
The method you choose depends on your preferences and the security requirements of your organization.
66

7-
These authentication methods are not mutually exclusive,
7+
These authentication methods are not mutually exclusive;
88
you can use multiple methods to access your account.
99

1010
Email and password
@@ -42,7 +42,7 @@ Google authentication works well for users already using Google services,
4242
and easily integrates into your existing workflow.
4343

4444
Google provides authentication, but not authorization.
45-
This means that you can login to Read the Docs with this method,
45+
This means that you can log in to Read the Docs with this method,
4646
but we aren't able to determine which projects you have access to automatically.
4747

4848
.. seealso::
@@ -61,7 +61,7 @@ This is only available on Enterprise plans,
6161
and requires custom integration to be enabled.
6262

6363
SAML provides authentication, but not authorization.
64-
This means that users can login to Read the Docs with this method,
64+
This means that users can log in to Read the Docs with this method,
6565
but we aren't able to determine which projects each user has access to automatically.
6666

6767
.. seealso::

docs/user/intro/add-project.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Adding a documentation project
55
:description lang=en: Add your existing documentation from a Git repository into Read the Docs.
66

77
This page takes you through the process of adding a documentation project to Read the Docs.
8-
If you have :doc:`connected your Read the Docs account </guides/connecting-git-account>` to GitHub, Bitbucket or GitLab you will be able to add your project automatically.
8+
If you have :doc:`connected your Read the Docs account </guides/connecting-git-account>` to GitHub, Bitbucket, or GitLab, you will be able to add your project automatically.
99
Otherwise, you will need to add it manually and perform some extra steps.
1010

1111
Automatically add your project
@@ -17,7 +17,7 @@ Automatically add your project
1717
#. Click on :guilabel:`Continue`.
1818
#. Edit any of the pre-filled fields with information of the repository.
1919
#. Click on :guilabel:`Next`.
20-
#. Add a :term:`configuration file` to your repository if it's doesn't exist yet.
20+
#. Add a :term:`configuration file` to your repository if it doesn't exist yet.
2121
#. Click on :guilabel:`This file exists`.
2222

2323
.. seealso::
@@ -35,7 +35,7 @@ Manually add your project
3535
#. Click on :guilabel:`Continue`.
3636
#. Fill all the fields of the form.
3737
#. Click on :guilabel:`Next`.
38-
#. Add a :term:`configuration file` to your repository if it's doesn't exist yet.
38+
#. Add a :term:`configuration file` to your repository if it doesn't exist yet.
3939
#. Click on :guilabel:`This file exists`.
4040

4141
Once your project is created, you'll need to manually configure the repository webhook if you would like to have new changes trigger builds for your project on Read the Docs.
@@ -45,7 +45,6 @@ Once your project is created, you'll need to manually configure the repository w
4545
:doc:`/guides/setup/git-repo-manual`
4646
Additional setup steps required for manually created projects. This guide covers setting up SSH keys and webhook integrations.
4747

48-
4948
What's next
5049
-----------
5150

docs/user/intro/doctools.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ Popular documentation tools
22
===========================
33

44
Read the Docs provides documentation hosting for any tool that can output HTML.
5-
We provide a number of features on top of that that is well-suited to documentation specifically,
5+
We provide a number of features that are well-suited to documentation specifically,
66
but you can host any kind of HTML content on Read the Docs.
77

88
Below is a list of popular documentation tools that you can use to write your documentation.

docs/user/intro/docusaurus.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
Docusarus
2-
=========
1+
Docusaurus
2+
==========
33

44
.. meta::
55
:description lang=en: Hosting Docusaurus sites on Read the Docs.
66

77
`Docusaurus`_ is a static-site generator that builds a single-page application with fast client-side navigation and out-of-the-box documentation features.
88

99
Minimal configuration required to build a Docusaurus project on Read the Docs looks like this,
10-
specifying a nodejs toolchain on Ubuntu, using multiple :ref:`build <config-file/v2:build>` jobs to install the requirements,
10+
specifying a Node.js toolchain on Ubuntu, using multiple :ref:`build <config-file/v2:build>` jobs to install the requirements,
1111
build the site, and copy the output to $READTHEDOCS_OUTPUT:
1212

1313
.. code-block:: yaml
1414
:caption: .readthedocs.yaml
1515
1616
version: 2
1717
build:
18-
os: "ubuntu-22.04"
19-
tools:
18+
os: "ubuntu-22.04"
19+
tools:
2020
nodejs: "18"
21-
jobs:
21+
jobs:
2222
# "docs/" was created following the Docusaurus tutorial:
2323
# npx create-docusaurus@latest docs classic
2424
# but you can just use your existing Docusaurus site
2525
install:
26-
# Install Docusaurus dependencies
27-
- cd docs/ && npm install
26+
# Install Docusaurus dependencies
27+
- cd docs/ && npm install
2828
build:
2929
html:
3030
# Build the site
@@ -42,22 +42,20 @@ Limitations
4242
:header: "Feature", "Description", "Supported"
4343

4444
"Search", "Provides full-text search capabilities.", "Not supported"
45-
"Files changed", "Ability to see what HTML files changes in pull request previews", "Not supported"
46-
45+
"Files changed", "Ability to see what HTML files change in pull request previews.", "Not supported"
4746

4847
Quick start
4948
-----------
5049

5150
- If you have an existing Docusaurus project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide.
52-
5351
- If you're new to Docusaurus, check out the official `Fast Track`_ guide.
5452

5553
.. _Fast Track: https://docusaurus.io/docs#fast-track
5654

57-
Configuring Docusaurus and Read the Docs addons
55+
Configuring Docusaurus and Read the Docs Addons
5856
-----------------------------------------------
5957

60-
For optimal integration with Read the Docs, make the optional following configuration changes to your Docusaurus config.
58+
For optimal integration with Read the Docs, make the following optional configuration changes to your Docusaurus config.
6159

6260
.. contents::
6361
:depth: 1
@@ -70,7 +68,7 @@ Set the canonical URL
7068
A :doc:`canonical URL </canonical-urls>` allows you to specify the preferred version of a web page
7169
to prevent duplicated content.
7270

73-
Set your Docusaurus `url`_ to your Read the Docs canonical URL using `dotenv <https://www.npmjs.com/package/dotenv>`__ and a
71+
Set your Docusaurus `url`_ to your Read the Docs canonical URL using `dotenv <https://www.npmjs.com/package/dotenv>`__ and a
7472
:doc:`Read the Docs environment variable </reference/environment-variables>`:
7573

7674
.. code-block:: js

docs/user/intro/markdoc.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Example configuration
3434
---------------------
3535

3636
In order to build a Markdoc project on Read the Docs,
37-
you need to generate static HTML from the Next JS build:
37+
you need to generate static HTML from the Next.js build:
3838

3939
.. code-block:: js
4040
:caption: next.config.js

0 commit comments

Comments
 (0)