Skip to content

Add translation for Quick Start #281

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add translation for Quick Start #281

wants to merge 6 commits into from

Conversation

expliyh
Copy link
Contributor

@expliyh expliyh commented May 23, 2025

Fix some translation in #277
Add Chinese translation for Quick Start
Add Chinese translation for sidebar

Before Submitting This PR, Please Ensure You Have Completed The Following:

  1. Are internal links to wiki documents using relative file links?
  2. Are all new documentation files lowercase, with dash separated names (ex. unraid-os.mdx)?
  3. Are all assets (images, etc), located in an assets/ subfolder next to the .md/mdx files?
  4. Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  5. Is the build succeeding?

Summary by CodeRabbit

  • New Features

    • Added comprehensive Chinese-language documentation for Unraid OS, including getting started guides, advanced BIOS configuration, installation instructions, and post-setup considerations.
    • Introduced a Simplified Chinese localization file for sidebar categories and descriptions in the documentation.
  • Bug Fixes

    • Corrected folder naming and clarified default UEFI boot behavior in the Chinese installation FAQ.
  • Documentation

    • Improved clarity and accuracy in the Chinese Unraid OS FAQ with editorial updates and refined instructions.

Copy link
Contributor

coderabbitai bot commented May 23, 2025

📝 Walkthrough

Walkthrough

This update introduces a new Simplified Chinese localization JSON file for sidebar labels and descriptions in the Unraid OS documentation, along with several new and revised Chinese-language documentation files. The additions include comprehensive guides for getting started, manual installation, BIOS configuration, and improved FAQ content, all tailored for Chinese-speaking users.

Changes

File(s) Change Summary
i18n/zh/docusaurus-plugin-content-docs/current.json Added a new Simplified Chinese localization JSON file containing translations and descriptions for sidebar category labels and generated index pages in Unraid OS documentation.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md Updated instructions about enabling UEFI boot mode by removing the manual folder renaming explanation and adding a note that newer Unraid versions enable UEFI boot by default.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/os-faq.md Made minor textual corrections and clarifications in the Chinese Unraid OS FAQ documentation, improving fluency, accuracy, and definitiveness without changing procedural content.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/advanced-bios-config.md Added a new advanced BIOS configuration guide in Chinese, detailing motherboard and storage controller settings for stable Unraid OS operation, troubleshooting steps, and BIOS limitations regarding boot device selection.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/considerations.md Added a new "Considerations" guide in Chinese, providing instructions on flash device backup, using the built-in help system, and security best practices for Unraid OS users.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/getting-started.md Added a new Chinese-language getting started guide for Unraid OS, covering hardware requirements, initial setup, and considerations for virtualization and hardware planning.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/manual-install-method.md Added a new manual installation guide in Chinese, detailing step-by-step instructions for creating a bootable USB device for Unraid OS without the official tool, including OS-specific activation steps.
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md Added a comprehensive quick installation guide in Chinese, explaining USB creation, BIOS configuration, WebGUI access, license registration, storage assignment, array management, Unraid Connect plugin, and troubleshooting.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Docs (Chinese)
    participant Unraid OS

    User->>Docs (Chinese): Accesses sidebar/navigation
    Docs (Chinese)-->>User: Displays localized sidebar (from current.json)
    User->>Docs (Chinese): Reads Getting Started/Install/FAQ guides
    Docs (Chinese)-->>User: Presents step-by-step Chinese documentation
    User->>Unraid OS: Follows setup/configuration steps
    Unraid OS-->>User: System responds per documentation instructions
Loading

Poem

🐇
In burrows deep, translations grow,
Chinese guides for all to know.
BIOS tips and install with flair,
Quick start steps are everywhere!
Now every bunny far and wide,
Can hop through Unraid, side by side.
文档新添,快乐常在!

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🧹 Nitpick comments (1)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/os-faq.md (1)

31-31: Consistent spacing around 'Unraid' in the sentence.

Insert a space for clarity and consistency:

- 最后,您需要在新的闪存设备上安装 Unraid,启动Unraid服务器,然后在新闪存上安装旧的注册密钥...
+ 最后,您需要在新的闪存设备上安装 Unraid,启动 Unraid 服务器,然后在新闪存上安装旧的注册密钥...
🧰 Tools
🪛 LanguageTool

[uncategorized] ~31-~31: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:新"地"闪
Context: ...设备。其次,您需要找到包含您之前闪存设备注册密钥的电子邮件。 最后,您需要在新的闪存设备上安装 Unraid,启动Unraid服务器,然后在新闪存上安装旧的注册...

(wb4)


[uncategorized] ~31-~31: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:旧"地"注册
Context: ...在新的闪存设备上安装 Unraid,启动Unraid服务器,然后在新闪存上安装旧的注册密钥(通过 工具 → 注册 页面)。然后您可以申请并安装替换密钥。 关于您...

(wb4)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b11a7eb and ddff310.

⛔ Files ignored due to path filters (6)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/assets/Booting.jpg is excluded by !**/*.jpg
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/assets/Configuringarray1.png is excluded by !**/*.png
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/assets/Set_root_password.png is excluded by !**/*.png
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/assets/Upc_get_started.png is excluded by !**/*.png
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/assets/Upc_install_trial_key.png is excluded by !**/*.png
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/assets/toolbar.png is excluded by !**/*.png
📒 Files selected for processing (8)
  • i18n/zh/docusaurus-plugin-content-docs/current.json (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/os-faq.md (3 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/advanced-bios-config.md (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/considerations.md (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/getting-started.md (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/manual-install-method.md (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md

[uncategorized] ~40-~40: 数词与名词之间一般应存在量词,可能缺少量词。
Context: ...assets/Set_root_password.png) 建议密码满足:至少8字符、字母/数字/符号组合、非常见词典词汇。推荐使用密码管理器生成。 <!-- 后...

(wa5)


[uncategorized] ~59-~59: 您的意思是“"账"户”?
Context: ...Upc_install_trial_key.png) 您的Unraid帐户将自动关联许可证管理(获取试用/购买/恢复/更换/升级密钥)。 :::imp...

(ZHANG7_ZHANG8)


[uncategorized] ~98-~98: "间"不能与“阵列”搭配,请换量词
Context: ... 勾选Format确认提示后执行格式化 * 后台将执行奇偶校验同步(同步期间阵列处于无保护状态,建议等待同步完成再写入数据) ### 停止阵列/关机/重启...

(wa5)

i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/os-faq.md

[uncategorized] ~29-~29: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:新"地"闪
Context: ...致的配置丢失。若您没有配置闪存备份,请按如下步骤操作。 首先,您需要获取一个新的闪存设备。请记住使用来自 Kingston、PNY、Lexar 或 Samsun...

(wb4)


[uncategorized] ~31-~31: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:新"地"闪
Context: ...设备。其次,您需要找到包含您之前闪存设备注册密钥的电子邮件。 最后,您需要在新的闪存设备上安装 Unraid,启动Unraid服务器,然后在新闪存上安装旧的注册...

(wb4)


[uncategorized] ~31-~31: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:旧"地"注册
Context: ...在新的闪存设备上安装 Unraid,启动Unraid服务器,然后在新闪存上安装旧的注册密钥(通过 工具 → 注册 页面)。然后您可以申请并安装替换密钥。 关于您...

(wb4)

i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/considerations.md

[uncategorized] ~18-~18: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:详尽"地"帮助
Context: ...# 使用内置帮助系统 Unraid 的 WebGUI为 所有主要设置提供了详尽的帮助文本。启用后,相关帮助信息将显示在对应设置下方。 您可以通过点击 WebG...

(wb4)

🪛 markdownlint-cli2 (0.17.2)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md

74-74: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)


74-74: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


75-75: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)


75-75: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (4)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/manual-install-method.md (1)

17-17: Verify the download archive filename and link format.

The link uses download_list.mdx, but our naming conventions prescribe lowercase with dash separators (e.g., download-list.mdx). Please confirm the actual filename and update the link accordingly:

- 4. 前往[下载归档](../download_list.mdx)获取所需版本ZIP文件
+ 4. 前往[下载归档](../download-list.mdx)获取所需版本ZIP文件
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/considerations.md (1)

1-28: Overall translation and formatting look good.

The document is clear, links are correct, and terminology is consistent.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~18-~18: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:详尽"地"帮助
Context: ...# 使用内置帮助系统 Unraid 的 WebGUI为 所有主要设置提供了详尽的帮助文本。启用后,相关帮助信息将显示在对应设置下方。 您可以通过点击 WebG...

(wb4)

i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/getting-started.md (1)

1-49: Translation and structure look solid

The document follows project guidelines: relative links, lowercase filenames, clear Chinese localization, and consistent styling. No issues identified.

i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/advanced-bios-config.md (1)

1-30: Excellent translation and formatting

This guide is clear, uses proper relative links, and the lists are consistently styled. It is ready to merge.

Copy link

This pull request is automatically being deployed by Amplify Hosting (learn more).

Access this pull request here: https://pr-281.d1o5s833kbd339.amplifyapp.com

@expliyh expliyh marked this pull request as draft May 23, 2025 16:07
@expliyh expliyh marked this pull request as ready for review May 23, 2025 16:22
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

♻️ Duplicate comments (2)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md (2)

67-67: Duplicate translation for UI tab label “Main”
Replace 主页面 with Main to match the product’s UI terminology and maintain consistency across the docs.


100-100: Duplicate translation for UI tab label “Main”
Replace 主页面 with Main to match the product’s UI terminology and maintain consistency across the docs.

🧹 Nitpick comments (2)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md (2)

57-57: Unify terminology: use “账号” instead of “帐户”
Line 57 uses “您的Unraid帐户”,but earlier in the guide you used “账号” when referring to the login ID. For consistency in Chinese UI context, please replace “帐户” with “账号”.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~57-~57: 您的意思是“"账"户”?
Context: ...Upc_install_trial_key.png) 您的Unraid帐户将自动关联许可证管理(获取试用/购买/恢复/更换/升级密钥)。 :::imp...

(ZHANG7_ZHANG8)


72-73: Align list style and indentation with markdownlint rules
Static analysis flagged that the sub-list under 阵列设备 uses dashes and 4-space indentation. Consider switching to asterisks (*) with 2-space indentation. For example:

-    - 奇偶校验盘:提供数据冗余保护(最多2个)
-    - 数据盘:存储用户文件
+  * 奇偶校验盘:提供数据冗余保护(最多2个)
+  * 数据盘:存储用户文件
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

72-72: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)


72-72: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


73-73: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)


73-73: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between ddff310 and 69c3578.

📒 Files selected for processing (2)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md (1 hunks)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/faq/installation.md
🧰 Additional context used
🪛 LanguageTool
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md

[uncategorized] ~57-~57: 您的意思是“"账"户”?
Context: ...Upc_install_trial_key.png) 您的Unraid帐户将自动关联许可证管理(获取试用/购买/恢复/更换/升级密钥)。 :::imp...

(ZHANG7_ZHANG8)


[uncategorized] ~96-~96: "间"不能与“阵列”搭配,请换量词
Context: ... 勾选Format确认提示后执行格式化 * 后台将执行奇偶校验同步(同步期间阵列处于无保护状态,建议等待同步完成再写入数据) ### 停止阵列/关机/重启...

(wa5)

🪛 markdownlint-cli2 (0.17.2)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md

72-72: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)


72-72: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)


73-73: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)


73-73: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: AWS Amplify Console Web Preview
🔇 Additional comments (1)
i18n/zh/docusaurus-plugin-content-docs/current/unraid-os/getting-started/quick-install-guide.md (1)

38-38: Verify asset link paths for images
All image links (e.g., ![设置密码], ![UPC开始界面], ![UPC安装试用密钥], ![配置阵列]) use ../assets/.... Please confirm that the assets folder is indeed located one level up from this file. If your assets are placed in getting-started/assets/, the correct relative path should be ./assets/<filename>. Otherwise, the images may not render correctly in the Chinese docs.

Also applies to: 54-56, 68-68

@ljm42
Copy link
Member

ljm42 commented May 23, 2025

Thank you so much for helping to translate our docs! But I need to let you know that we are in the process of completely reorganizing and rewriting our docs. When that happens these translations will be lost.

Would you be open to holding off on translating this content until the new site is up?

@expliyh
Copy link
Contributor Author

expliyh commented May 24, 2025 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants