Skip to content

Docs: Relabel Localization as Explanation (Diátaxis) #9790

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

Merged
3 changes: 1 addition & 2 deletions docs/user/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ to help you create fantastic documentation for your project.
:glob:
:caption: Explanation

/localization
/build-notifications
/downloadable-documentation

Expand Down Expand Up @@ -233,8 +234,6 @@ out of your documentation and Read the Docs.
flyout-menu
feature-flags

localization

user-defined-redirects
automatic-redirects

Expand Down
30 changes: 19 additions & 11 deletions docs/user/localization.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,25 @@
Localization of Documentation
=============================

.. note:: This feature only applies to Sphinx documentation. We are working to bring it to our other documentation backends.
In this article, we explain high-level approaches to internationalizing and localizing your documentation.

Read the Docs supports hosting your docs in multiple languages.
There are two different things that we support:
By default, Read the Docs assumes that your documentation is or *might become* multilingual one day.
The initial default language is English and
therefore you often see the initial build of your documentation published at ``/en/latest/``,
where the ``/en`` denotes that it's in English.
By having the ``en`` URL component present from the beginning,
you are ready for the eventuality that you would want a second language.

* A single project written in another language
* A project with translations into multiple languages
Read the Docs supports hosting your documentation in multiple languages.

.. contents::
:local:

Single project in another language
----------------------------------
Single language project
-----------------------

If your documentation isn't in English (the default),
you should indicate which language you have written it in.

It is easy to set the *Language* of your project.
On the project *Admin* page (or *Import* page),
Expand All @@ -22,10 +30,8 @@ The language will be represented in the URL for your project.
For example,
a project that is in Spanish will have a default URL of ``/es/latest/`` instead of ``/en/latest/``.

.. note:: You must commit the ``.po`` files for Read the Docs to translate your documentation.

Project with multiple translations
----------------------------------
Project with multiple translations (Sphinx)
-------------------------------------------

This situation is a bit more complicated.
To support this,
Expand Down Expand Up @@ -58,3 +64,5 @@ It also gets included in the Read the Docs flyout:
but each project must specify the language to build for those docs.

.. note:: You can read :doc:`guides/manage-translations-sphinx` to understand the whole process for a documentation with multiples languages in the same repository and how to keep the translations updated on time.

.. note:: You must commit the ``.po`` files for Read the Docs to translate your documentation.