openstack
/
contributor-guide
Code Issues Proposed changes

Make a couple of links translatable 

Sphinx lets you do links like this:

 Lorem ipsum dolor sit amet, consectetur `adipiscing elit`_

 .. adipiscing elit: https://foo.com/bar/baz.html#blah

In the rendered version, the "adipiscing elit" appears as a hyperlink to
the foo.com address; and the .. line doesn't show up at all.

This makes translators sad.

They either translate "adipiscing elit" and lose the hyperlink
(generating a warning when the translated document is built), or leave
it untranslated and wind up with English (or in this example, doglatin)
phrases in the middle of their sentence.

As a practice, this kind of linking should only be used in a
translatable document if the link text is the actual title of the
target. When it's natural words in a sentence, the following form is
preferred:

 Lorem ipsum dolor sit amet, consectetur `adipiscing elit <https://foo.com/bar/baz.html#blah>`_

This renders the exact same way; but now the translator can translate
"adipiscing elit" and preserve both the link and the language of the
sentence.

This patch switches out two such links.

Change-Id: I28bb450dd5525fe916bc982b64f727cf83a76f2c
This commit is contained in:
Eric Fried 2019-02-01 13:21:13 -06:00
parent 24f6e7cab2
commit 372bd47012
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/code-and-documentation/using-gerrit.rst
View File

@ -195,7 +195,7 @@ This score does not often appear and when it does, it's for a good reason:
* Most often, some deadline has passed and since no more changes are
being accepted till the new release development begins, the patch
is `being held`.
is `being held <https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#procedural-minus-2>`_.
* There is an issue with the approach taken in the patch and it needs
to be discussed with a larger group, likely in a meeting.
* The patch submitted is a duplicate or at odds with another patch
@ -223,9 +223,11 @@ before it is merged into the repository.
Checking Out Others' Changes
============================
It is possible to check out other contributors' patches from Gerrit and even
`make changes to them`_; however, you should always discuss any changes with
the contributor before you start working on their patch.
It is possible to check out other contributors' patches from Gerrit and
even `make changes to them
<https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#modifying-a-change>`_;
however, you should always discuss any changes with the contributor
before you start working on their patch.
.. code-block:: console
@ -259,5 +261,3 @@ The change ID is the same as in the previous case.
.. _0: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#code-review-0
.. _-1: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#code-review-minus-1
.. _-2: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#code-review-minus-2
.. _being held: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#procedural-minus-2
.. _make changes to them: https://docs.openstack.org/project-team-guide/review-the-openstack-way.html#modifying-a-change