[OpenStack-docs] [OpenStack-I18n] request for help from ESL readers
Ian Y. Choi
ianyrchoi at gmail.com
Mon Apr 3 16:53:21 UTC 2017
Hello Brian,
Thanks a lot for your sharing on thoughts on the spec.
Recently, Docs team added a paragraph for new contributors with English
as a second language [1],
but the perspective you are asking is something different from [1] I think.
For me, it seems that the paragraph does not clearly answer the question
"How do you identify a producer or consumer?".
In my opinion, the purpose of the detail description on this paragraph
is to recall more thoughts
with 'project ID' and 'user ID', and when I first see the title
(question), I expect such as
"There are several approaches which help users to identify a producer
or consumer".
"The first is ..., which .... It is useful when ... However, there can
be a problem when...".
"The other possible approach can be ... It really solves the problem
in the first approach by ...
However, there may be still some problems on ...".
Then, I try to relate those two approaches I think into 'project ID' and
'user ID', but it is a little bit
difficult for me to map into those two approaches with the details,
advantages, and disadvantages.
This is just my thought from my brief review when I read the spec, and I
hope that
more I18n team members and also Docs team contributors help better
description for readers with English as Second Language.
With many thanks,
/Ian
[1]
https://docs.openstack.org/contributor-guide/non-native-english-speakers.html
Brian Rosmaita wrote on 4/3/2017 12:06 AM:
> Hello i18n team,
>
> There's a section of Glance documentation that's written in a colloquial
> american english style, but some contributors have expressed concern
> that this attempt to make a concept clear to non-technical american
> english readers may actually make it more difficult for ESL readers to
> understand. It would be awesome if a few ESL people would take a look
> and let us know what you think:
>
> http://specs.openstack.org/openstack/glance-specs/specs/api/v2/sharing-image-api-v2.html#how-do-you-identify-a-producer-or-consumer
>
> thanks,
> brian
>
> _______________________________________________
> OpenStack-I18n mailing list
> OpenStack-I18n at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-i18n
More information about the OpenStack-docs
mailing list