search

cncf / techdocs

CNCF TechDocs Team
https://cncf.io
Apache License 2.0
43 stars 26 forks source link

Initialize Localization READMEs template #260

Open Okabe-Junya opened 5 months ago

Okabe-Junya commented 5 months ago

Feature Descriptions

ref. https://github.com/cncf/techdocs/pull/259#issuecomment-2173954621

I think it would be good to have an English version of this as well (even if it's very rough or just an outline). I'd like to use this work as a template or starting point for other languages.

Okabe-Junya commented 5 months ago

cc @nate-double-u

Please take a look, thank you :)

nate-double-u commented 5 months ago

Thanks for this @Okabe-Junya!

/cc @a-mccarthy @chalin

Okabe-Junya commented 5 months ago

I see, I agree with your opinion, @chalin

but my feeling is that it’s too early to offer a template.

If there are no issues, I would like to close this PR within a week (or feel free to close this)

When the time comes to create such a template, please let me help!

a-mccarthy commented 5 months ago

but my feeling is that it’s too early to offer a template.

It might be too early for a template, but I think its still helpful to provide a checklist or bullet points of what folks should think about if they want to add localization into their project. The concepts behind what you included in this guide @Okabe-Junya are really good, and a helpful start for someone who is maybe just starting

Even if we just start creating a list of good examples of localization being done by other projects, I think it would make it easier if you get questions later from a project looking to get started localizing.

Okabe-Junya commented 4 months ago

but my feeling is that it’s too early to offer a template.

It might be too early for a template, but I think its still helpful to provide a checklist or bullet points of what folks should think about if they want to add localization into their project.

Cool! I think a checklist or bullet points is a good start too, WDYT @chalin?

chalin commented 3 months ago

Cool! I think a checklist or bullet points is a good start too, WDYT @chalin?

I'm not 100% sure what @a-mccarthy has in mind, but in this case I defer to her judgement and further approval of what you might submit. Would that work for you @a-mccarthy? (Also, did you have in mind of closing this PR and having a new one created. Please clarify what you had in mind, thanks!)