spec icon indicating copy to clipboard operation
spec copied to clipboard

Any plan for the spec i18n?

Open pigletfly opened this issue 5 years ago • 22 comments

is there a plan for the spec i18n?

pigletfly avatar Nov 15 '19 06:11 pigletfly

No plan at the moment, but open to ideas on how to proceed. In my mind, the obvious thing to start with is offering translated versions of the specification text and documentation, which we would need some help with. I'm happy to add that to our roadmap ideas.

vturecek avatar Nov 15 '19 19:11 vturecek

We could consider to start a spec i18n project :-)

/cc @captainroy-hy

resouer avatar Nov 15 '19 20:11 resouer

We could consider to start a spec i18n project :-)

/cc @captainroy-hy

I’m glad to contribute to the Chinese version spec.

captainroy-hy avatar Nov 16 '19 11:11 captainroy-hy

We could consider to start a spec i18n project :-) /cc @captainroy-hy

I’m glad to contribute to the Chinese version spec.

me too, and I am translating, maybe we could work together to speed up it

iHuangYaoshi avatar Nov 17 '19 10:11 iHuangYaoshi

@KaiwenWang @captainroy-hy let's work together. I could setup i18n framework in the project.

wonderflow avatar Nov 18 '19 02:11 wonderflow

@wonderflow @KaiwenWang Great!

captainroy-hy avatar Nov 18 '19 04:11 captainroy-hy

glad to contribute to the Chinese version

pigletfly avatar Nov 18 '19 06:11 pigletfly

Which chapter of them do you like translate? We could split the work.

wonderflow avatar Nov 18 '19 06:11 wonderflow

I noticed @KaiwenWang has already finished several chapters and so did I. And I mark several chapters I like on the list.

  • [x] 1.purpose_and_goals.md @KaiwenWang
  • [x] 2.overview_and_terminology.md @KaiwenWang
  • [ ] 3.component_model.md
  • [ ] 4.application_scopes.md
  • [ ] 5.traits.md
  • [ ] 6.application_configuration.md @captainroy-hy
  • [ ] 7.workload_types.md @captainroy-hy
  • [ ] 8.practical_considerations.md @captainroy-hy
  • [x] 9.design_principles.md @KaiwenWang
  • [ ] code-of-conduct.md
  • [ ] CONTRIBUTING.md
  • [ ] governance.md
  • [x] introduction.md @captainroy-hy
  • [ ] LICENSE
  • [ ] notational_convention.md
  • [ ] OWNERS.md
  • [x] README.md @captainroy-hy

And maybe we can join a wechat group to talk about this issue...? 😄

captainroy-hy avatar Nov 18 '19 08:11 captainroy-hy

yeah, my wechat ID is wonderflow

wonderflow avatar Nov 18 '19 08:11 wonderflow

I think some of them don't need to be translated, so it seems only four of them are left:

  • [x] 1.purpose_and_goals.md @KaiwenWang
  • [x] 2.overview_and_terminology.md @KaiwenWang
  • [ ] 3.component_model.md @pigletfly
  • [ ] 4.application_scopes.md @LeoLiuYan
  • [ ] 5.traits.md @pigletfly
  • [ ] 6.application_configuration.md @captainroy-hy
  • [ ] 7.workload_types.md @captainroy-hy
  • [ ] 8.practical_considerations.md @captainroy-hy
  • [x] 9.design_principles.md @KaiwenWang
  • [x] ~~code-of-conduct.md~~
  • [x] ~~CONTRIBUTING.md~~
  • [x] ~~governance.md~~
  • [x] introduction.md @captainroy-hy
  • [x] ~~LICENSE~~
  • [ ] notational_convention.md
  • [x] ~~OWNERS.md~~
  • [x] README.md @captainroy-hy

Which sections do you love to translate? @pigletfly

wonderflow avatar Nov 18 '19 09:11 wonderflow

I'd like to take component_model.md and traits.md sections.

pigletfly avatar Nov 18 '19 09:11 pigletfly

Cool! @pigletfly

wonderflow avatar Nov 18 '19 09:11 wonderflow

Cool!Count me in. @wonderflow pls add me in the i18n wechat group~

grumpyAmber avatar Nov 18 '19 09:11 grumpyAmber

Let me create a new issue to track this work.

wonderflow avatar Nov 18 '19 09:11 wonderflow

Nobody translate application_scopes.md? Maybe I can. @wonderflow

LeoLiuYan avatar Nov 18 '19 09:11 LeoLiuYan

Cool! Let me add to the tracker.

wonderflow avatar Nov 18 '19 09:11 wonderflow

Thank for wonderflow. I will complete the 1,2 and 9th doc as soon as possible and pull request

iHuangYaoshi avatar Nov 18 '19 14:11 iHuangYaoshi

I think we should use to keep the original content,then it would be more convenient for reviewers.And can we provide a guide and a glossary for the translation? There would be other language translations. WDYT? @wonderflow

pigletfly avatar Nov 18 '19 14:11 pigletfly

+1 for guide and glossary, there is an example for l10n contributor guide, we could also setup a glossary page, for example like this.

BTW, how we serve the site https://oam.dev ? If we deploy the site after each PR merged, like k8s did, I think it would make our content more easier to stay up-to-update.

Colstuwjx avatar Mar 20 '20 02:03 Colstuwjx

Our site is hosted in this repo . I totally agree we need to setup localization contributor guide like K8s. Thanks for you suggestion @Colstuwjx

wonderflow avatar Mar 22 '20 03:03 wonderflow

It seems that we're also using hugo + netlify to serve the website, the same to k8s website. We could see the k8s document structure. With the help of hugo multilingual feature support, each language has its own content dir, for example, the default one is en.

I wonder if we could merge these two repo, and also make the l10n content like this? Currently, if we want to read the spec, the website redirects our users to the github repo. It works, but not good enough.

On the other hand, I think it's a long-term job if we decide to do this change, and the oam spec document is above ~10 pages, it's not a big repo, so I also wonder if it deserve to do this change.

Just a suggestion :)

Colstuwjx avatar Mar 22 '20 03:03 Colstuwjx

邮件已收到,谢谢

zt810950783 avatar Apr 19 '23 03:04 zt810950783