Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
2 changes: 1 addition & 1 deletion docs/user/commercial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down
4 changes: 2 additions & 2 deletions docs/user/commercial/organizations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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,
Expand Down
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
Expand Down
9 changes: 4 additions & 5 deletions docs/user/commercial/sharing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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
---------------
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/user/commercial/subscriptions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
--------------------------
Expand All @@ -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.
Expand Down Expand Up @@ -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.
6 changes: 3 additions & 3 deletions docs/user/intro/accounts.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Account authentication methods
Read the Docs supports several authentication methods for creating an account and logging in.
The method you choose depends on your preferences and the security requirements of your organization.

These authentication methods are not mutually exclusive,
These authentication methods are not mutually exclusive;
you can use multiple methods to access your account.

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

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

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

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

.. seealso::
Expand Down
7 changes: 3 additions & 4 deletions docs/user/intro/add-project.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Adding a documentation project
:description lang=en: Add your existing documentation from a Git repository into Read the Docs.

This page takes you through the process of adding a documentation project to Read the Docs.
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.
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.
Otherwise, you will need to add it manually and perform some extra steps.

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

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

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.
Expand All @@ -45,7 +45,6 @@ Once your project is created, you'll need to manually configure the repository w
:doc:`/guides/setup/git-repo-manual`
Additional setup steps required for manually created projects. This guide covers setting up SSH keys and webhook integrations.


What's next
-----------

Expand Down
2 changes: 1 addition & 1 deletion docs/user/intro/doctools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Popular documentation tools
===========================

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

Below is a list of popular documentation tools that you can use to write your documentation.
Expand Down
26 changes: 12 additions & 14 deletions docs/user/intro/docusaurus.rst
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
Docusarus
=========
Docusaurus
==========

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

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

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

.. code-block:: yaml
:caption: .readthedocs.yaml

version: 2
build:
os: "ubuntu-22.04"
tools:
os: "ubuntu-22.04"
tools:
nodejs: "18"
jobs:
jobs:
# "docs/" was created following the Docusaurus tutorial:
# npx create-docusaurus@latest docs classic
# but you can just use your existing Docusaurus site
install:
# Install Docusaurus dependencies
- cd docs/ && npm install
# Install Docusaurus dependencies
- cd docs/ && npm install
build:
html:
# Build the site
Expand All @@ -42,22 +42,20 @@ Limitations
:header: "Feature", "Description", "Supported"

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

"Files changed", "Ability to see what HTML files change in pull request previews.", "Not supported"

Quick start
-----------

- If you have an existing Docusaurus project you want to host on Read the Docs, check out our :doc:`/intro/add-project` guide.

- If you're new to Docusaurus, check out the official `Fast Track`_ guide.

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

Configuring Docusaurus and Read the Docs addons
Configuring Docusaurus and Read the Docs Addons
-----------------------------------------------

For optimal integration with Read the Docs, make the optional following configuration changes to your Docusaurus config.
For optimal integration with Read the Docs, make the following optional configuration changes to your Docusaurus config.

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

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

.. code-block:: js
Expand Down
2 changes: 1 addition & 1 deletion docs/user/intro/markdoc.rst
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Example configuration
---------------------

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

.. code-block:: js
:caption: next.config.js
Expand Down
23 changes: 11 additions & 12 deletions docs/user/intro/mdbook.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,17 @@ Minimal configuration is required to build an existing mdBook project on Read th
version: 2

build:
os: ubuntu-lts-latest
tools:
rust: latest
jobs:
install:
- cargo install mdbook
build:
html:
# For an example book..
# - mdbook init docs
- mdbook build docs --dest-dir $READTHEDOCS_OUTPUT/html
os: ubuntu-lts-latest
tools:
rust: latest
jobs:
install:
- cargo install mdbook
build:
html:
# For an example book..
# - mdbook init docs
- mdbook build docs --dest-dir $READTHEDOCS_OUTPUT/html

.. _mdBook: https://rust-lang.github.io/mdBook/

Expand All @@ -36,7 +36,6 @@ Getting started

.. _Getting started with mdBook: https://rust-lang.github.io/mdBook/guide/creating.html


Example repository and demo
---------------------------

Expand Down
10 changes: 4 additions & 6 deletions docs/user/intro/mkdocs.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ MkDocs
:description lang=en: Hosting MkDocs sites on Read the Docs.

`MkDocs`_ is a fast, simple static site generator that's geared towards building project documentation.
Mkdocs is written in Python, and supports documentation written in Markdown.
MkDocs is written in Python, and supports documentation written in Markdown.
When using MkDocs, we recommend using the `Material for MkDocs`_ theme,
and this guide is mostly focused on the integration required to make it work well on Read the Docs.

Expand Down Expand Up @@ -68,15 +68,15 @@ Set the canonical URL
A :doc:`canonical URL </canonical-urls>` allows you to specify the preferred version of a web page
to prevent duplicated content.

Set your MkDocs `site URL`_ to your Read the Docs canonical URL using a
Set your MkDocs `site URL`_ to your Read the Docs canonical URL using a
:doc:`Read the Docs environment variable </reference/environment-variables>`:

.. code-block:: yaml
:caption: mkdocs.yml

site_url: !ENV READTHEDOCS_CANONICAL_URL

.. _Site URL: https://www.mkdocs.org/user-guide/configuration/#site_url
.. _site URL: https://www.mkdocs.org/user-guide/configuration/#site_url

Configuring Material for MkDocs and Read the Docs Addons
--------------------------------------------------------
Expand Down Expand Up @@ -114,18 +114,16 @@ To configure your site to use :doc:`Read the Docs search </server-side-search/in
extra_javascript:
- javascript/readthedocs.js


Integrate the Read the Docs version menu into your site navigation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To integrate the :ref:`flyout-menu:Addons flyout menu` version menu into your site navigation
To integrate the :ref:`flyout-menu:Addons flyout menu` version menu into your site navigation:

#. Override the ``main.html`` template to include the data in the ``meta`` attribute:

.. code-block:: html
:caption: overrides/main.html


{% extends "base.html" %}

{% block site_meta %}
Expand Down
Loading