Skip to content

docs: rename WSProxy to App Proxy across the manual#7442

Open
yomybaby wants to merge 1 commit into
mainfrom
05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual
Open

docs: rename WSProxy to App Proxy across the manual#7442
yomybaby wants to merge 1 commit into
mainfrom
05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual

Conversation

@yomybaby
Copy link
Copy Markdown
Member

@yomybaby yomybaby commented May 16, 2026

⚠️ Review note — please review in #7472.
During review, several factual inaccuracies were found in this PR and corrected in the stacked follow-up #7472 (docs(FR-2916): correct WSProxy→App Proxy rename inaccuracies and recapture resource group screenshots).

#7472 contains the corrected, reviewable state, including:

  • overview.md (en/ko/ja/th) reverted to main — its Local/Web wsproxy section describes the WebUI client-side proxy, not the renamed server-side App Proxy (out of scope here)
  • TERMINOLOGY.md corrected — there is no internal wsproxy daemon (v1 = Manager-embedded stream proxy; v2 = separate App Proxy Coordinator + Worker)
  • (formerly WSProxy) parenthetical removed across the manual; v1/v2 fallback sentence trimmed
  • modify_resource_group.png / create_resource_group.png recaptured in all 4 languages

Review #7472 for the final intended content; this PR is the base of that correction stack.


Documentation-side follow-through of the WSProxy → App Proxy rename (i18n keys/values renamed in FR-2841, #7300).

Renames the user-facing "WSProxy" label to "App Proxy" across the user manual (en/ko/ja/th):

  • Resource group settings fields (App Proxy Server Address / App Proxy API Token) in admin_menu.md
  • Troubleshooting guide reference in trouble_shooting.md
  • Hardware requirements list in appendix.md
  • New "App Proxy" terminology entry in TERMINOLOGY.md

The exact corrected scope is captured in stacked PR #7472 (see review note above).

Checklist:

  • Documentation
  • Minimum required manager version
  • Specific setting for review (eg., KB link, endpoint or how to setup)
  • Minimum requirements to check during review
  • Test case(s) to demonstrate the difference of before/after

@github-actions github-actions Bot added the size:M 30~100 LoC label May 16, 2026
Copy link
Copy Markdown
Member Author

yomybaby commented May 16, 2026


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • flow:merge-queue - adds this PR to the back of the merge queue
  • flow:hotfix - for urgent changes, fast-track this PR to the front of the merge queue

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has required the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

This stack of pull requests is managed by Graphite. Learn more about stacking.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR renames the user-facing label "WSProxy" to "App Proxy" across the Backend.AI WebUI user manual to match the UI label change introduced in FR-2841, while preserving lowercase wsproxy in code style when the docs refer to the internal binary/daemon. A new terminology section codifies the rule across English, Korean, Japanese, and Thai.

Changes:

  • Added an "App Proxy (formerly WSProxy)" entry plus a "do not use" row in TERMINOLOGY.md with per-language field labels.
  • Updated overview, troubleshooting, and admin-menu pages in en, ko, ja, th to use "App Proxy" for UI references and to wrap daemon references in `wsproxy` code style.
  • Verified the docs labels match the i18n strings (AppProxyAddress, AppProxyAPIToken) already shipped in resources/i18n/*.json.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
packages/backend.ai-webui-docs/TERMINOLOGY.md Adds App Proxy terminology section, per-language field labels, and a deprecation row.
packages/backend.ai-webui-docs/src/en/overview/overview.md Switches daemon references to wsproxy code style and notes the App Proxy UI label.
packages/backend.ai-webui-docs/src/en/trouble_shooting/trouble_shooting.md Renames WSProxy service mention to "App Proxy (formerly WSProxy)".
packages/backend.ai-webui-docs/src/en/admin_menu/admin_menu.md Updates resource group field labels to App Proxy.
packages/backend.ai-webui-docs/src/ko/overview/overview.md Korean equivalent of the overview update.
packages/backend.ai-webui-docs/src/ko/trouble_shooting/trouble_shooting.md Korean troubleshooting rename.
packages/backend.ai-webui-docs/src/ko/admin_menu/admin_menu.md Korean resource group field-label rename.
packages/backend.ai-webui-docs/src/ja/overview/overview.md Japanese overview update.
packages/backend.ai-webui-docs/src/ja/trouble_shooting/trouble_shooting.md Japanese troubleshooting rename.
packages/backend.ai-webui-docs/src/ja/admin_menu/admin_menu.md Japanese resource group field-label rename.
packages/backend.ai-webui-docs/src/th/overview/overview.md Thai overview update.
packages/backend.ai-webui-docs/src/th/trouble_shooting/trouble_shooting.md Thai troubleshooting rename.
packages/backend.ai-webui-docs/src/th/admin_menu/admin_menu.md Thai resource group field-label rename.

Comment thread packages/backend.ai-webui-docs/TERMINOLOGY.md
FR-2841 (#7300) renamed all WSProxy i18n keys/values to App Proxy in the UI. This updates the user manual accordingly.

- admin_menu Resource Group fields: WSProxy Server Address → App Proxy Server Address, WSProxy API Token → App Proxy API Token
- overview: keep architectural `wsproxy` daemon mentions in inline code; clarify UI surface is App Proxy
- trouble_shooting: update WSProxy references to App Proxy
- TERMINOLOGY.md: new App Proxy entry with formerly-WSProxy guidance and Terms-to-Avoid row

Updated in all 4 languages (en/ko/ja/th).

Part of the recent main-branch docs catch-up plan (Work Item 5).
Copy link
Copy Markdown
Contributor

@ironAiken2 ironAiken2 left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:L 100~500 LoC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants