[Django] #25077: Named links in the documentation it is impossible to translate into other languages.

17 views
Skip to first unread message

Django

unread,
Jul 7, 2015, 9:07:21 AM7/7/15
to django-...@googlegroups.com
#25077: Named links in the documentation it is impossible to translate into other
languages.
-------------------------------+--------------------
Reporter: djbaldey | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Keywords:
Triage Stage: Unreviewed | Has patch: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------
For Russian-speaking users, [http://djbook.ru/rel1.8/ there is a
translation of the Django documentation]. Working on it for a few people.
Periodically translations are synchronize with upstream. And there is one,
but the '''big problem''' with the translation links in the documentation.

Example:

{{{
Although you can use Django without a database, it comes with an
`object-relational mapper`_ in which you describe your database layout in
Python
code.

.. _object-relational mapper: http://en.wikipedia.org/wiki/Object-
relational_mapping
}}}

If translate text link `object-relational mapper` in the paragraph, then
in some versions of shpinx such links are crumbling.

Safer work anonymous links (In the file `intro/contributing.txt` it's done
that way):

{{{
Although you can use Django without a database, it comes with an
`object-relational mapper`__ in which you describe your database layout in
Python
code.

__ http://en.wikipedia.org/wiki/Object-relational_mapping
}}}

It certainly does not concern `slug links`, such as:

{{{
`link-to-other-page`_ and `translated link to page <link-to-page-2>`_
}}}


Might be worth globally in all of the original documentation named links
to replace to anonymous?

Thanks.

--
Ticket URL: <https://code.djangoproject.com/ticket/25077>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Jul 7, 2015, 9:33:44 AM7/7/15
to django-...@googlegroups.com
#25077: Named links in the documentation it is impossible to translate into other
languages.
-------------------------------+--------------------------------------

Reporter: djbaldey | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by timgraham):

* needs_better_patch: => 0
* needs_tests: => 0
* needs_docs: => 0


Comment:

Maybe you'd like to contribute to the
[https://docs.djangoproject.com/en/1.8/internals/contributing/localizing/#documentation
official effort] to translate the documentation rather than maintain a
fork? It seems this problem doesn't exist in our workflow (checked
[https://docs.djangoproject.com/fr/1.8/intro/overview/ French
translation]).

--
Ticket URL: <https://code.djangoproject.com/ticket/25077#comment:1>

Django

unread,
Jul 7, 2015, 10:12:45 AM7/7/15
to django-...@googlegroups.com
#25077: Named links in the documentation it is impossible to translate into other
languages.
-------------------------------+--------------------------------------

Reporter: djbaldey | Owner: nobody
Type: Uncategorized | Status: new
Component: Documentation | Version: 1.8
Severity: Normal | Resolution:
Keywords: | Triage Stage: Unreviewed

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------

Comment (by djbaldey):

I see several reasons why not everyone wants to work with Transifex.
1. Don't see the translated files in `docs/`.
2. How then to collect documentation on our language with the help of
shpinx for yourself?
3. One big file translate on the entire section is not convenient.

Our translations can be safely would be to pour (using git) to the
upstream of Django docs.
He has already made 76% far fewer people than 12% on Transifex.

--
Ticket URL: <https://code.djangoproject.com/ticket/25077#comment:2>

Django

unread,
Jul 7, 2015, 11:24:34 AM7/7/15
to django-...@googlegroups.com
#25077: Named links in the documentation it is impossible to translate into other
languages.
-------------------------------+--------------------------------------
Reporter: djbaldey | Owner: nobody
Type: Uncategorized | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: invalid
Keywords: | Triage Stage: Unreviewed

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------
Changes (by timgraham):

* status: new => closed
* resolution: => invalid


--
Ticket URL: <https://code.djangoproject.com/ticket/25077#comment:3>

Django

unread,
Jul 7, 2015, 11:31:38 AM7/7/15
to django-...@googlegroups.com
#25077: Named links in the documentation it is impossible to translate into other
languages.
-------------------------------+--------------------------------------
Reporter: djbaldey | Owner: nobody
Type: Uncategorized | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: invalid
Keywords: | Triage Stage: Unreviewed

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------

Comment (by timgraham):

Sorry, but I don't think it's really a sustainable solution. For example,
enforcing "no named links" in new pull requests will be annoying.

--
Ticket URL: <https://code.djangoproject.com/ticket/25077#comment:4>

Django

unread,
Jul 7, 2015, 4:43:09 PM7/7/15
to django-...@googlegroups.com
#25077: Named links in the documentation it is impossible to translate into other
languages.
-------------------------------+--------------------------------------
Reporter: djbaldey | Owner: nobody
Type: Uncategorized | Status: closed
Component: Documentation | Version: 1.8
Severity: Normal | Resolution: invalid
Keywords: | Triage Stage: Unreviewed

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0

Easy pickings: 0 | UI/UX: 0
-------------------------------+--------------------------------------

Comment (by claudep):

@djbaldey Feel free to discuss documentation translation on django-i18n
mailing list.
https://groups.google.com/forum/#!forum/django-i18n

--
Ticket URL: <https://code.djangoproject.com/ticket/25077#comment:5>

Reply all
Reply to author
Forward
0 new messages