docs(FR-2916): correct WSProxy→App Proxy rename inaccuracies and recapture resource group screenshots#7472
Open
ironAiken2 wants to merge 1 commit into
Conversation
…pture resource group screenshots
This was referenced May 18, 2026
This was referenced May 18, 2026
Contributor
Author
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
How to use the Graphite Merge QueueAdd either label to this PR to merge it via 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. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR corrects follow-up documentation inaccuracies from the WSProxy → App Proxy rename across the Backend.AI WebUI user manual and terminology guidance.
Changes:
- Updates App Proxy terminology guidance to clarify that
wsproxyremains only as internal identifiers/client-side proxy naming. - Removes “formerly WSProxy” parentheticals and trims v1/v2 fallback wording in admin and troubleshooting docs across en/ko/ja/th.
- Restores overview wording for the WebUI client-side
wsproxylayer and recaptures resource group screenshots.
Reviewed changes
Copilot reviewed 13 out of 21 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
packages/backend.ai-webui-docs/TERMINOLOGY.md |
Clarifies App Proxy vs wsproxy terminology. |
packages/backend.ai-webui-docs/src/en/admin_menu/admin_menu.md |
Updates App Proxy field description. |
packages/backend.ai-webui-docs/src/ko/admin_menu/admin_menu.md |
Updates Korean App Proxy field description. |
packages/backend.ai-webui-docs/src/ja/admin_menu/admin_menu.md |
Updates Japanese App Proxy field description. |
packages/backend.ai-webui-docs/src/th/admin_menu/admin_menu.md |
Updates Thai App Proxy field description. |
packages/backend.ai-webui-docs/src/en/overview/overview.md |
Restores client-side wsproxy overview text. |
packages/backend.ai-webui-docs/src/ko/overview/overview.md |
Restores Korean client-side wsproxy overview text. |
packages/backend.ai-webui-docs/src/ja/overview/overview.md |
Restores Japanese client-side wsproxy overview text. |
packages/backend.ai-webui-docs/src/th/overview/overview.md |
Restores Thai client-side wsproxy overview text. |
packages/backend.ai-webui-docs/src/en/trouble_shooting/trouble_shooting.md |
Removes legacy WSProxy parenthetical. |
packages/backend.ai-webui-docs/src/ko/trouble_shooting/trouble_shooting.md |
Removes Korean legacy WSProxy parenthetical. |
packages/backend.ai-webui-docs/src/ja/trouble_shooting/trouble_shooting.md |
Removes Japanese legacy WSProxy parenthetical. |
packages/backend.ai-webui-docs/src/th/trouble_shooting/trouble_shooting.md |
Removes Thai legacy WSProxy parenthetical. |
packages/backend.ai-webui-docs/src/en/images/modify_resource_group.png |
Recaptures English resource group edit screenshot. |
packages/backend.ai-webui-docs/src/ko/images/modify_resource_group.png |
Recaptures Korean resource group edit screenshot. |
packages/backend.ai-webui-docs/src/ja/images/modify_resource_group.png |
Recaptures Japanese resource group edit screenshot. |
packages/backend.ai-webui-docs/src/th/images/modify_resource_group.png |
Recaptures Thai resource group edit screenshot. |
packages/backend.ai-webui-docs/src/en/images/create_resource_group.png |
Recaptures English resource group creation screenshot. |
packages/backend.ai-webui-docs/src/ko/images/create_resource_group.png |
Recaptures Korean resource group creation screenshot. |
packages/backend.ai-webui-docs/src/ja/images/create_resource_group.png |
Recaptures Japanese resource group creation screenshot. |
packages/backend.ai-webui-docs/src/th/images/create_resource_group.png |
Recaptures Thai resource group creation screenshot. |
Comments suppressed due to low confidence (3)
packages/backend.ai-webui-docs/src/en/overview/overview.md:89
- The lowercase
wsproxyreferences in this Web proxy bullet should remain inline code. Otherwise the manual treats an internal identifier as a user-facing term, which conflicts with the documented terminology guidance forwsproxy.
- Web wsproxy: In the case of the Web-UI provided in a web, the built-in
server cannot be used due to the nature of the browser. In this case, you
can use services such as Jupyter Notebook, Terminal, etc. in the web
environment by making the wsproxy server as a separate web server
so that the Web-UI app can see the web wsproxy.
packages/backend.ai-webui-docs/src/ja/overview/overview.md:25
- The lowercase
wsproxyidentifier should stay in inline code style in this restored text. TERMINOLOGY.md line 157 says lowercasewsproxyshould only be used for internal identifiers and kept in code style, so rendering it as plain prose can confuse it with a user-facing term.
- Web wsproxy: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、wsproxyサーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb wsproxyを参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。
packages/backend.ai-webui-docs/src/th/overview/overview.md:25
- The lowercase
wsproxyidentifier should stay in inline code style in this restored text. TERMINOLOGY.md line 157 says lowercasewsproxyshould only be used for internal identifiers and kept in code style, so rendering it as plain prose can confuse it with a user-facing term.
- Web wsproxy: ในกรณีของ Web-UI ที่จัดเตรียมไว้ในเว็บ เซิร์ฟเวอร์ที่ติดตั้งมายังไม่สามารถใช้งานได้เนื่องจากธรรมชาติของเบราว์เซอร์ ในกรณีนี้ คุณสามารถใช้บริการต่าง ๆ เช่น Jupyter Notebook, Terminal, ฯลฯ ในสภาพแวดล้อมเว็บโดยการทำให้เซิร์ฟเวอร์ wsproxy เป็นเซิร์ฟเวอร์เว็บแยกที่สามารถทำให้แอป Web-UI มองเห็นเว็บ wsproxy ได้
Comment on lines
+80
to
+84
| - Local wsproxy: Proxy server built into the Web-UI app. Local wsproxy converts | ||
| general HTTP requests between the server and Web-UI app to websocket and | ||
| delivers the messages. If the Web-UI app loses its connection to wsproxy or | ||
| the wsproxy server is dead, it will not be possible to access services such as | ||
| Jupyter Notebook and Terminal. |
| can use services such as Jupyter Notebook, Terminal, etc. in the web | ||
| environment by making the `wsproxy` server a separate web server | ||
| so that the Web-UI app can see the web `wsproxy`. | ||
| environment by making the wsproxy server as a separate web server |
Comment on lines
+71
to
+74
| - 로컬 wsproxy: Web-UI 앱에 내장된 프록시 서버입니다. 로컬 wsproxy는 서버와 | ||
| Web-UI 앱 간의 일반 HTTP 요청을 websocket으로 변환하여 메시지를 전달합니다. | ||
| Web-UI 앱과 `wsproxy` 간의 연결이 끊기거나 `wsproxy` 서버가 중단되면 Jupyter | ||
| Notebook, Terminal 등의 서비스에 접속할 수 없습니다. WebUI 화면에서는 이 | ||
| 구성 요소를 **App Proxy**(이전 명칭 WSProxy)로 표기합니다. | ||
| - 웹 `wsproxy`: 웹 형태로 제공되는 Web-UI의 경우, 브라우저의 특성상 내장 서버를 | ||
| 사용할 수 없습니다. 이 경우 `wsproxy` 서버를 별도의 웹 서버로 구성하여 Web-UI | ||
| 앱이 웹 `wsproxy`를 바라보게 함으로써, 웹 환경에서도 Jupyter Notebook, Terminal | ||
| Web-UI 앱과 wsproxy 간의 연결이 끊기거나 wsproxy 서버가 중단되면 Jupyter | ||
| Notebook, Terminal 등의 서비스에 접속할 수 없습니다. |
Comment on lines
+75
to
+77
| - 웹 wsproxy: 웹 형태로 제공되는 Web-UI의 경우, 브라우저의 특성상 내장 서버를 | ||
| 사용할 수 없습니다. 이 경우 wsproxy 서버를 별도의 웹 서버로 구성하여 Web-UI | ||
| 앱이 웹 wsproxy를 바라보게 함으로써, 웹 환경에서도 Jupyter Notebook, Terminal |
Comment on lines
+24
to
+25
| - ローカル wsproxy: Web-UI アプリに組み込まれたプロキシサーバー。ローカル wsproxy は、サーバーと Web-UI アプリ間の一般的な HTTP リクエストを WebSocket に変換し、メッセージを送信します。Web-UI アプリが wsproxy への接続を失うか、wsproxy サーバーが停止すると、Jupyter Notebook やターミナルなどのサービスにアクセスすることはできません。 | ||
| - Web wsproxy: Web上で提供されるWeb-UIの場合、ブラウザの特性上、組み込みサーバーを使用することはできません。この場合、wsproxyサーバーを別のWebサーバーとして設定し、Web-UIアプリがWeb wsproxyを参照できるようにすることで、Jupyter NotebookやターミナルなどのサービスをWeb環境で使用できます。 |
Comment on lines
+24
to
+25
| - wsproxy ท้องถิ่น: เซิร์ฟเวอร์พร็อกซีที่สร้างขึ้นในแอป Web-UI. wsproxy ท้องถิ่นจะแปลงคำขอ HTTP ทั่วไประหว่างเซิร์ฟเวอร์กับแอป Web-UI เป็น websocket และส่งข้อความไปยังกันและกัน หากแอป Web-UI สูญเสียการเชื่อมต่อกับ wsproxy หรือเซิร์ฟเวอร์ wsproxy หยุดทำงาน จะไม่สามารถเข้าถึงบริการต่างๆ เช่น Jupyter Notebook และ Terminal ได้. | ||
| - Web wsproxy: ในกรณีของ Web-UI ที่จัดเตรียมไว้ในเว็บ เซิร์ฟเวอร์ที่ติดตั้งมายังไม่สามารถใช้งานได้เนื่องจากธรรมชาติของเบราว์เซอร์ ในกรณีนี้ คุณสามารถใช้บริการต่าง ๆ เช่น Jupyter Notebook, Terminal, ฯลฯ ในสภาพแวดล้อมเว็บโดยการทำให้เซิร์ฟเวอร์ wsproxy เป็นเซิร์ฟเวอร์เว็บแยกที่สามารถทำให้แอป Web-UI มองเห็นเว็บ wsproxy ได้ |
| ### Users cannot launch apps like Jupyter Notebook | ||
|
|
||
| There may be a problem on connecting the App Proxy (formerly WSProxy) service. | ||
| There may be a problem on connecting the App Proxy service. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves #7470(FR-2916)
Follow-up correction PR stacked on top of #7442 (
docs: rename WSProxy to App Proxy across the manual). While reviewing #7442, several factual inaccuracies were found and corrected (verified against the Backend.AI core repo).Changes
overview.md(en/ko/ja/th) → reverted tomain. The rename PR incorrectly annotated the Local/Web wsproxy section as the component surfaced as "App Proxy" in the UI. That section describes the WebUI client-side proxy (src/wsproxy/,config.tomlwsproxy.proxyURL) — a different layer from the renamed server-side App Proxy. It is out of scope for the FR-2841 UI rename, so it is restored tomain.TERMINOLOGY.mdcorrected. The new section falsely claimed an internalwsproxybinary/daemon still exists. Core verification: there is no standalonewsproxydaemon — v1 is a Manager-embedded stream proxy, v2 is a separate App Proxy Coordinator + Worker service family.wsproxysurvives only as internal identifiers (DB columnsscaling_groups.wsproxy_addr/wsproxy_api_token, API route/scaling-groups/{sg}/wsproxy-version, constantWSPROXY_V1_VERSION). Description, authoring guidance, and the mapping-table row updated accordingly.admin_menu.md/trouble_shooting.md(en/ko/ja/th). Removed the(formerly WSProxy)parenthetical across the manual and trimmed the v1/v2 fallback sentence from the App Proxy Server Address field description.Screenshots recaptured.
modify_resource_group.pngandcreate_resource_group.pngin all 4 languages — the old captures still showed theWSProxylabel. Recaptured modal-only at 2× zoom, per-locale UI, sensitive API token masked.Checklist: