docs.openstack.org - What to put on translated pages?
Reviewing https://review.openstack.org/#/c/162045, I noticed that the patch adds all manuals to it - so both the translated Korean ones as well as English titles. In the past, the translated pages only contained links to translated manuals but not to English ones. But I noticed that the Japanese index page was changed recently as well and puts up all the document. How do we want to continue here? My suggest would be to only list translated manuals on a localized index page to not confuse the users. Andreas -- Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany GF: Felix Imendörffer, Jane Smithard, Jennifer Guild, Dilip Upmanyu, Graham Norton, HRB 21284 (AG Nürnberg) GPG fingerprint = 93A3 365E CE47 B889 DF7F FED1 389A 563C C272 A126
----- Original Message -----
From: "Andreas Jaeger" <aj@suse.com> To: openstack-docs@lists.openstack.org, openstack-i18n@lists.openstack.org
Reviewing https://review.openstack.org/#/c/162045, I noticed that the patch adds all manuals to it - so both the translated Korean ones as well as English titles.
In the past, the translated pages only contained links to translated manuals but not to English ones. But I noticed that the Japanese index page was changed recently as well and puts up all the document.
How do we want to continue here?
My suggest would be to only list translated manuals on a localized index page to not confuse the users.
Andreas
I disagree on this. Feedback I have received in the past (albeit on product, not community docs) is that while users would prefer to read the translated copy many will work with the English copy if it's the only one available. From a discoverability point of view if not all guides are listed on the language-specific landing pages then they may not even know a given guides exists (and that it needs translation, if they are willing to help). A way to make this clearer is to mark the English titles with a string equating to "untranslated" in the desired language next to them. -Steve
Interesting discussion. I would prefer not to include untranslated links in translated pages. Besides Korean page, there are Japanese, Chinese, French pages under docs.openstack.org. All of them contain only links to translated documents. They also have a link to the documentation home page, i.e. English home page with all links to English documents. We could mark this link as "To get more documents in English, please go documentation home page." Thus readers could know where to get more English documents. Best regards Ying Chun Guo (Daisy) Steve Gordon <sgordon@redhat.com> wrote on 2015/03/09 10:23:27:
From: Steve Gordon <sgordon@redhat.com> To: Andreas Jaeger <aj@suse.com> Cc: openstack-i18n@lists.openstack.org, openstack-docs@lists.openstack.org Date: 2015/03/09 10:58 Subject: Re: [Openstack-i18n] [OpenStack-docs] docs.openstack.org - What to put on translated pages?
----- Original Message -----
From: "Andreas Jaeger" <aj@suse.com> To: openstack-docs@lists.openstack.org, openstack-i18n@lists.openstack.org
Reviewing https://review.openstack.org/#/c/162045, I noticed that the patch adds all manuals to it - so both the translated Korean ones as well as English titles.
In the past, the translated pages only contained links to translated manuals but not to English ones. But I noticed that the Japanese index page was changed recently as well and puts up all the document.
How do we want to continue here?
My suggest would be to only list translated manuals on a localized index page to not confuse the users.
Andreas
I disagree on this. Feedback I have received in the past (albeit on product, not community docs) is that while users would prefer to read the translated copy many will work with the English copy if it's the only one available. From a discoverability point of view if not all guides are listed on the language-specific landing pages then they may not even know a given guides exists (and that it needs translation, if they are willing to help). A way to make this clearer is to mark the English titles with a string equating to "untranslated" in the desired language next to them.
-Steve
_______________________________________________ Openstack-i18n mailing list Openstack-i18n@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n
On Mon, Mar 9, 2015 at 1:01 AM, Ying Chun Guo <guoyingc@cn.ibm.com> wrote:
Interesting discussion.
I would prefer not to include untranslated links in translated pages. Besides Korean page, there are Japanese, Chinese, French pages under docs.openstack.org. All of them contain only links to translated documents. They also have a link to the documentation home page, i.e. English home page with all links to English documents. We could mark this link as "To get more documents in English, please go *documentation home page*." Thus readers could know where to get more English documents.
I think this approach is fine. Steve, I think that because Publican could easily generate the links to all the docs it made sense but with our toolchain it's likely more maintenance of links that could be error-prone. So I do acknowledge that an "all the docs regardless of language landing page" could be helpful, but not easy for us to maintain since it's just links. If we get to a point where each language landing page links to user groups and other resources, it would be even more language-centric and you'd want less English. Just a thought. Thanks all for the input and thank you Andreas for bringing it to the list for consideration. Anne
Best regards Ying Chun Guo (Daisy)
Steve Gordon <sgordon@redhat.com> wrote on 2015/03/09 10:23:27:
From: Steve Gordon <sgordon@redhat.com> To: Andreas Jaeger <aj@suse.com> Cc: openstack-i18n@lists.openstack.org, openstack-docs@lists.openstack.org Date: 2015/03/09 10:58 Subject: Re: [Openstack-i18n] [OpenStack-docs] docs.openstack.org - What to put on translated pages?
----- Original Message -----
From: "Andreas Jaeger" <aj@suse.com> To: openstack-docs@lists.openstack.org, openstack-i18n@lists.openstack.org
Reviewing https://review.openstack.org/#/c/162045, I noticed that the patch adds all manuals to it - so both the translated Korean ones as well as English titles.
In the past, the translated pages only contained links to translated manuals but not to English ones. But I noticed that the Japanese index page was changed recently as well and puts up all the document.
How do we want to continue here?
My suggest would be to only list translated manuals on a localized index page to not confuse the users.
Andreas
I disagree on this. Feedback I have received in the past (albeit on product, not community docs) is that while users would prefer to read the translated copy many will work with the English copy if it's the only one available. From a discoverability point of view if not all guides are listed on the language-specific landing pages then they may not even know a given guides exists (and that it needs translation, if they are willing to help). A way to make this clearer is to mark the English titles with a string equating to "untranslated" in the desired language next to them.
-Steve
_______________________________________________ Openstack-i18n mailing list Openstack-i18n@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n
_______________________________________________ OpenStack-docs mailing list OpenStack-docs@lists.openstack.org http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
-- Anne Gentle annegentle@justwriteclick.com
----- Original Message -----
From: "Anne Gentle" <annegentle@justwriteclick.com> To: "Ying Chun Guo" <guoyingc@cn.ibm.com>
Steve, I think that because Publican could easily generate the links to all the docs it made sense but with our toolchain it's likely more maintenance of links that could be error-prone. So I do acknowledge that an "all the docs regardless of language landing page" could be helpful, but not easy for us to maintain since it's just links. If we get to a point where each language landing page links to user groups and other resources, it would be even more language-centric and you'd want less English. Just a thought.
Thanks all for the input and thank you Andreas for bringing it to the list for consideration.
Anne
Yeah, I guess what I was angling at was is that automation we'd be interested in having added to our toolchain? Thanks, Steve
participants (4)
-
Andreas Jaeger
-
Anne Gentle
-
Steve Gordon
-
Ying Chun Guo