[Tool] Auto translate

[DanRoscigno]

This PR is to add a workflow that translates docs from English to Chinese. I can provide the GPT and W&B secrets.

Note:

This requires three secrets and a PAT. The details are below.

1. Detect changed Markdown or MDX files using tj-actions/changed-files
2. Translate Docusaurus Markdown from English to Chinese using tcapelle/gpt_translate
3. Automatically open a PR with the Chinese docs using peter-evans/create-pull-request

Setup

Github Personal Access Token

I used a fine-grained token limited to this repo. Here are the perms I gave:

• Read and Write access to code (content) and pull requests
• Read and Write access to pull requests

Additionally, GitHub automatically assigned:

• Read access to metadata

Repository secret

I created three repository secrets:

TRANSLATE_PAT

This contains the PAT created above.

OPENAI_API_KEY

This contains a GPT4 API key

WANDB_API_KEY

This contains the output of W&B authorize

Workflow file notes

• The workflow runs when a pull request with target main is closed by being merged. It does not run on every commit made to a PR as that is wasteful.
• The paths and filters in the workflow are specific to the StarRocks docs, you will need to change them.

gpt_translate configuration

The configuration is in the configs dir in this repo. At StarRocks we use a modified prompt and temperature in addition to a custom glossary in configs/language_dicts/zh.yaml. You can compare our prompt with the default from tcapelle/gpt_translate.

About Weights and Biases

You should read Weights & Biases, I am no expert. I do think that the Weave feature is going to be useful as I tune the prompt and glossary I am using. Weave keeps track of the changes and the impact. Additionally, W&B validates the translations for me automatically and provides scores. Seriously, I am no AI expert; check out their site.

What type of PR is this:

• BugFix
• Feature
• Enhancement
• Refactor
• UT
• Doc
• Tool

Does this PR entail a change in behavior?

• Yes, this PR will result in a change in behavior.
• No, this PR will not result in a change in behavior.

If yes, please specify the type of change:

• Interface/UI changes: syntax, type conversion, expression evaluation, display information
• Parameter changes: default values, similar parameters but with different default values
• Policy changes: use new policy to replace old one, functionality automatically enabled
• Feature removed
• Miscellaneous: upgrade & downgrade compatibility, etc.

Checklist:

• I have added test cases for my bug fix or my new feature
• This pr needs user documentation (for new or modified features or behaviors)
  • I have added documentation for my new feature or new function
• This is a backport pr

Bugfix cherry-pick branch check:

• I have checked the version labels which the pr will be auto-backported to the target branch
  • 3.3
  • 3.2
  • 3.1
  • 3.0
  • 2.5

[github-actions]

[FE Incremental Coverage Report]

✅ pass : 0 / 0 (0%)

[github-actions]

[BE Incremental Coverage Report]

✅ pass : 0 / 0 (0%)