istio.io icon indicating copy to clipboard operation
istio.io copied to clipboard

Add documentation in Ukrainian

Open Andygol opened this issue 1 year ago β€’ 10 comments

Description

I am pleased to present the translation of Istio's documentation into Ukrainian πŸ‡ΊπŸ‡¦. I hope this contribution will be reviewed and incorporated into the documentation.

The translation contains all the documentation except for the Reference/Configuration and Reference/Commands sections, which I hope will be added later.

image image
image image

Everything looks good except for one drawback. I couldn't get the desired result locally with the FAQ page in Ukrainian, while the English and Chinese versions work as expected. I have an issue (locally), when I click on a question, no action is taken, the answer section is not displayed.

If I missed something, please correct me and let me know what it was. πŸ™

Reviewers

  • [ ] Ambient
  • [x] Docs
  • [ ] Installation
  • [ ] Networking
  • [ ] Performance and Scalability
  • [ ] Extensions and Telemetry
  • [ ] Security
  • [ ] Test and Release
  • [ ] User Experience
  • [ ] Developer Infrastructure
  • [x] Localization/Translation

Andygol avatar Sep 11 '24 13:09 Andygol

😊 Welcome! This is either your first contribution to the Istio documentation repo, or it's been a while since you've been here. A few things you should know:

  • You can learn about how we write and maintain documentation, our style guidelines, and the available web site features by visiting Contributing to the Docs.

  • In the next few minutes, an automatic preview of your change will be built with a full copy of the istio.io website. You can find this preview by clicking on the Details link next to the deploy/netlify entry in the status section of this page.

  • We care about quality, so we've put in place a number of checks to ensure our documentation is top-notch. We do spell checking, sanitize the Markdown, ensure all hyperlinks point to a valid location, and more. If your PR doesn't pass one of these checks, you'll see a red X in the lint_istio.io entry in the status section. Click on the Details link to get a list of the problems with your PR. Fix those problems and push an update; this will automatically re-run the tests. Hopefully this time everything will be perfect!

  • Once your changes are accepted and merged into the repository, they will initially show up on https://preliminary.istio.io. The changes will be published to https://istio.io the next time we do a major release (which typically happens every 3 months or so). To publish them sooner, add a cherrypick/release-x.xx label, where x.xx is the current release of Istio.

Thanks for contributing!

Courtesy of your friendly welcome wagon.

istio-policy-bot avatar Sep 11 '24 13:09 istio-policy-bot

Hi @Andygol. Thanks for your PR.

I'm waiting for a istio member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

istio-testing avatar Sep 11 '24 13:09 istio-testing

/language uk

Andygol avatar Sep 11 '24 18:09 Andygol

Not sure how I feel about this, tbh. Keeping the translations up to date is a constant and continual effort, as can be seen by the multiple per day PRs to handle translations to Chinese by multiple people. Do we have enough of a contributor base fluent in Ukrainian to not only handle the translations, but also to review/approve? Has this been discussed in the workgroup meetings and/or TOC/SC?

dhawton avatar Sep 11 '24 19:09 dhawton

Hi @Andygol,

This clearly represents a lot of work and is a very large contribution. Thank you!

As @dhawton has said, we are not qualified to review it. My only experience here is with our Chinese documentation, which has many contributors. How would you recommend we (a) review the first drop (b) ensure it is kept up to date without it being a burden on you personally (c) manage divergence from the English docs?

For example, I see https://kubernetes.io/uk/docs/home/ has a tag

Information in this document may be out of date his document has an older update date than the original, so the information it contains may be out of date. If you're able to read English, see the English version for the most up-to-date information

That seems like something we could add with minimal effort, though it has downsides in that any update to the translated content will remove the warning, even if not all the changes are ported across. (Kubernetes PR)

craigbox avatar Sep 12 '24 08:09 craigbox

Hello @craigbox !

Thank you for your kind words about my translation efforts into Ukrainian. However, I see that the project is not ready to accept new languages due to the lack of a clear strategy in this direction.

At the current pace of the project's development, keeping the documentation up-to-date is a difficult but important task. However, keeping the translations of the documentation up-to-date imposes an additional burden.

Π°) The Ukrainian translation is currently up-to-date at the time of the creation of the PR and you can accept it as is. b) I am ready to join the Istio project and spend some of my free time keeping the Ukrainian documentation up to date. Obtaining a membership in the Istio organization with the respective powers for this will streamline the process. c) The approach that was borrowed from the Kubernetes documentation project requires a lot of manual work to find differences between versions, rather than the translation itself. This is not conducive to the creation and dissemination of documentation in other languages. The introduction of Translation Documentation Systems to keep translations up to date, such as CrowdIn, can change the situation for the better.

Andygol avatar Sep 12 '24 14:09 Andygol

I'm pretty happy with A and B, and if you're willing to help us with something with regard to C, I think we are good to go. I will put this on the agenda for the next working group meeting to confirm.

Can you suggest how we might do a spot check on your work? A few pages I translated with Google Translate seemed OK, but it would be good to have a human help out here

craigbox avatar Sep 15 '24 22:09 craigbox

I'm pretty happy with A and B

This is awesome 🀩, please keep me posted.

Can you suggest how we might do a spot check on your work? A few pages I translated with Google Translate seemed OK, but it would be good to have a human help out here

@Arhell, could you please do a spot check if you have time? ☝️

@craigbox regarding C, you may find comprehensive description in the Support on CrowdIn:

  • Creating a Project - https://support.crowdin.com/creating-project/
  • GitHub Integration - https://support.crowdin.com/github-integration/, and so on

As an open source project Istio is eligible for free plan. You may file your request hereΒ - https://crowdin.com/page/open-source-project-setup-request.

Andygol avatar Sep 16 '24 14:09 Andygol

πŸ‘‹ Hi there.

Are there any follow-ups regarding accepting Ukrainian translation of the documentation?

Andygol avatar Oct 08 '24 07:10 Andygol

We still need to arrange some way to review this, and then we can progress.

craigbox avatar Oct 08 '24 09:10 craigbox

I can help to review if needed. cc @ZackButcher

smarunich avatar Oct 29 '24 18:10 smarunich

I can help to review if needed. cc @ZackButcher

@craigbox what do you think? If we have atleast one round of review, we can get this in?

kfaseela avatar Oct 30 '24 08:10 kfaseela

I can help to review if needed. cc @ZackButcher

@craigbox what do you think? If we have atleast one round of review, we can get this in?

It is a huge effort that was put in place, it did took a while to review, in fact, I cannot say I was able to review everything, but the core and a multitude of the pages the translation is spot on and proofs the point it can be done periodically.

smarunich avatar Nov 04 '24 16:11 smarunich

+1 for merging

kfaseela avatar Nov 05 '24 17:11 kfaseela

Thanks to all who made this possible πŸ‘

Andygol avatar Nov 06 '24 08:11 Andygol

Be aware there will be some changes - at least one on the front page - that we'll want to be updated quickly when 1.24 lands in a day or two.

craigbox avatar Nov 06 '24 21:11 craigbox