docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish by yomybaby · Pull Request #7443 · lablup/backend.ai-webui

yomybaby · 2026-05-16T00:05:56Z

resolves #NNN (FR-MMM)

Rewrites the Model Serving documentation across all four locales (EN, JA, KO, TH) to reflect the new two-step deployment creation flow and the revised Endpoint Detail Page structure.

Creation flow changes:

Replaces the single "Service Launcher" section with a two-step flow: Create Deployment (deployment-level metadata only) followed by Add Revision (runtime configuration snapshot).
Documents the new Create Deployment modal fields: deployment name, Open To Public toggle, and resource group selection.
Documents the new Add Revision modal fields: runtime variant, environment/version, model storage, start command (Custom only), environment variables, resource preset, and auto-activate toggle.
Notes that the revision name field has been removed; revisions are now identified by auto-assigned revision numbers.
Documents Preset Mode for revision creation, including preset selector behavior, field pre-filling, and fallback to manual mode when no compatible presets exist.

Endpoint Detail Page changes:

Adds a new Deployment Alerts section documenting all contextual banners: Healthy/ready, private deployment token warning, no current revision, preparing, and not-in-project states.
Updates the Service Info card to reflect the new Visibility (Public/Private) tag, Resource Group as deployment-level metadata, and Shared Memory (SHM) in the resources field.
Documents the More Menu on the Service Info card and clarifies the filled (DeleteFilled) vs. outlined (DeleteOutlined) trash icon convention for permanent delete vs. soft delete.
Adds a Replicas section documenting the new Running/Terminated radio filter and the three independent status fields per replica (Lifecycle, Health, Traffic).
Adds a Revisions Tab section documenting revision number ordering, column definitions, filtering/sorting, and the Apply action with its rollout behavior.
Updates the service termination instructions to use the More menu → Delete Deployment flow with typed-confirmation modal instead of the Controls column Delete button.

Adds new screenshots for the Create Deployment modal, Add Revision modal, endpoint detail visibility tag, endpoint detail private alert, endpoint detail More menu, and revision history tab across all locales.

Checklist:

Documentation
Minium 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

yomybaby · 2026-05-16T00:06:08Z

docs(rbac): align with revoke/remove confirmation flow and localized scope names #7446 : 2 dependent PRs (#7447 , #7463 )
docs(admin): document Prometheus Query Preset management UI #7445
docs(model-serving): capture deployment preset edit page screenshot #7460
docs(model-serving): add Deployment Preset management documentation #7444
docs(model-serving): capture endpoint detail ready-alert and replica-filter screenshots #7459
docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish #7443 👈 (View in Graphite)
docs: rename WSProxy to App Proxy across the manual #7442 : 1 other dependent PR (#7472 )
main

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.

Copilot

Pull request overview

Updates the Model Serving section of the user manual (EN, KO, JA, TH) to reflect the new two-step deployment + revision workflow, the redesigned Endpoint Detail Page (deployment alerts, Visibility/SHM, More menu, Replicas filter, Revisions tab), and the unified "Apply" terminology. Also refreshes the termination instructions to use the new typed-confirmation Delete Deployment flow.

Changes:

Replaces the single Service Launcher description with separate Create Deployment, Add Revision, and Preset-mode sections, and keeps the existing field reference as a follow-up subsection.
Expands the Endpoint Detail Page with new alert variants, Visibility/Resource Group/SHM fields, More menu/delete-icon conventions, a Replicas tab, and a Revisions tab with an Apply action.
Rewrites the "Terminating the Service" guidance to point at the More menu's Delete Deployment flow.

Reviewed changes

Copilot reviewed 4 out of 28 changed files in this pull request and generated 4 comments.

File	Description
packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md	English source updated for the new deployment/revision flow and Endpoint Detail Page sections.
packages/backend.ai-webui-docs/src/ko/model_serving/model_serving.md	Korean translation kept structurally in sync with the English changes.
packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md	Japanese translation kept structurally in sync with the English changes.
packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md	Thai translation kept structurally in sync with the English changes.

Comments suppressed due to low confidence (2)

packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md:565

endpoint_detail_shm.png does not exist in the repository, and the adjacent TODO comment confirms the screenshot has not been captured yet. The same broken image reference is added to the ko, ja, and th translations. Capture the screenshot or remove the reference before merging to avoid a broken image in published docs.

![](../images/endpoint_detail_shm.png)
<!-- TODO: Capture screenshot — SHM displayed in endpoint detail config -->

packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md:585

replica_status_filter.png does not exist anywhere under src/*/images/, and the adjacent TODO confirms it has not been captured. The same broken reference is added to all four language versions. Capture the screenshot or remove the image (and TODO) before merging.

![](../images/replica_status_filter.png)
<!-- TODO: Capture screenshot — Running/Terminated radio filter -->

agatha197

LGTM

graphite-app · 2026-05-19T15:17:01Z

Merge activity

May 19, 3:17 PM UTC: agatha197 added this pull request to the Graphite merge queue.
May 19, 3:24 PM UTC: Merged by the Graphite merge queue.

…n UX, and detail page polish (#7443) resolves #NNN (FR-MMM) Rewrites the Model Serving documentation across all four locales (EN, JA, KO, TH) to reflect the new two-step deployment creation flow and the revised Endpoint Detail Page structure. **Creation flow changes:** - Replaces the single "Service Launcher" section with a two-step flow: **Create Deployment** (deployment-level metadata only) followed by **Add Revision** (runtime configuration snapshot). - Documents the new **Create Deployment** modal fields: deployment name, Open To Public toggle, and resource group selection. - Documents the new **Add Revision** modal fields: runtime variant, environment/version, model storage, start command (Custom only), environment variables, resource preset, and auto-activate toggle. - Notes that the revision name field has been removed; revisions are now identified by auto-assigned revision numbers. - Documents **Preset Mode** for revision creation, including preset selector behavior, field pre-filling, and fallback to manual mode when no compatible presets exist. **Endpoint Detail Page changes:** - Adds a new **Deployment Alerts** section documenting all contextual banners: Healthy/ready, private deployment token warning, no current revision, preparing, and not-in-project states. - Updates the Service Info card to reflect the new **Visibility** (Public/Private) tag, **Resource Group** as deployment-level metadata, and **Shared Memory (SHM)** in the resources field. - Documents the **More Menu** on the Service Info card and clarifies the filled (`DeleteFilled`) vs. outlined (`DeleteOutlined`) trash icon convention for permanent delete vs. soft delete. - Adds a **Replicas** section documenting the new Running/Terminated radio filter and the three independent status fields per replica (Lifecycle, Health, Traffic). - Adds a **Revisions Tab** section documenting revision number ordering, column definitions, filtering/sorting, and the **Apply** action with its rollout behavior. - Updates the service termination instructions to use the More menu → Delete Deployment flow with typed-confirmation modal instead of the Controls column Delete button. Adds new screenshots for the Create Deployment modal, Add Revision modal, endpoint detail visibility tag, endpoint detail private alert, endpoint detail More menu, and revision history tab across all locales. **Checklist:** - [ ] Documentation - [ ] Minium 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

…filter screenshots (#7459) > **Stacked on** #7443 (`docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish`). Follow-up polish that resolves the screenshot `TODO` placeholders introduced by #7443 in `model_serving.md`. No separate issue (small completion of #7443's own scope). ## Summary - Captured **`endpoint_detail_ready_alert.png`** and **`replica_status_filter.png`** from the live WebUI on a healthy deployment, in all 4 locales (en/ja/ko/th), at 2× zoom via `window.switchLanguage` per `SCREENSHOT-GUIDELINES.md`. - Removed the 2 corresponding `` comments in `src/{en,ja,ko,th}/model_serving/model_serving.md` (8 lines total). Image references and surrounding blank lines unchanged. ## Intentionally left as-is - **`endpoint_detail_shm.png` TODO kept.** The live Endpoint Detail Page has no "Service Info" card (it renders "Basic Information") and surfaces **no Shared Memory (SHM)** field for the available deployment (verified via DOM scan). Capturing it would require fabrication — and it signals a **doc↔UI mismatch** in #7443's prose that should be addressed in #7443, not faked here. - **Cross-reference `TODO` (Deployment Presets link) kept.** `deployment_presets.md` is added by #7444, which is stacked above #7443; restoring the link here would create a broken internal link. Belongs in #7444's scope. ## Notes for #7443 author - The ready-alert section describes a **"Start Chat"** button, but the actual UI button is **"Test in Chat"** (visible in the new screenshot). Prose-only fix, out of scope for this PR. ## Test plan - [ ] `src/{en,ja,ko,th}/images/endpoint_detail_ready_alert.png` and `replica_status_filter.png` render in the manual. - [ ] Each locale's screenshot shows that locale's UI strings. - [ ] Only the SHM + cross-reference TODOs remain in `model_serving.md`. 🤖 Generated with [Claude Code](https://claude.com/claude-code)

github-actions Bot assigned yomybaby May 16, 2026

github-actions Bot added the size:XL 500~ LoC label May 16, 2026

yomybaby marked this pull request as ready for review May 18, 2026 02:04

Copilot AI review requested due to automatic review settings May 18, 2026 02:04

Copilot started reviewing on behalf of yomybaby May 18, 2026 02:05 View session

Copilot AI reviewed May 18, 2026

View reviewed changes

agatha197 force-pushed the 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual branch from a6f0429 to deb757e Compare May 18, 2026 03:54

agatha197 force-pushed the 05-15-docs_model-serving_update_for_deployment-only_create_modal_revision_ux_and_detail_page_polish branch 2 times, most recently from 1b25189 to accb898 Compare May 18, 2026 05:20

agatha197 force-pushed the 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual branch from deb757e to b1307b7 Compare May 18, 2026 05:20

agatha197 force-pushed the 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual branch from b1307b7 to dcc10dc Compare May 18, 2026 06:29

agatha197 force-pushed the 05-15-docs_model-serving_update_for_deployment-only_create_modal_revision_ux_and_detail_page_polish branch from accb898 to 47bc665 Compare May 18, 2026 06:29

ironAiken2 mentioned this pull request May 18, 2026

docs(FR-2909): align RBAC manual with revoke confirmation modal and refresh screenshots #7463

Merged

5 tasks

agatha197 mentioned this pull request May 18, 2026

docs(FR-2912): migrate deployment presets into admin menu and remove service launcher references #7466

Open

ironAiken2 mentioned this pull request May 18, 2026

docs(FR-2916): correct WSProxy→App Proxy rename inaccuracies and recapture resource group screenshots #7472

Merged

5 tasks

ironAiken2 changed the base branch from 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual to graphite-base/7443 May 19, 2026 03:44

agatha197 approved these changes May 19, 2026

View reviewed changes

agatha197 mentioned this pull request May 19, 2026

docs(sessions): fix note block indentation in sessions docs #7484

Merged

5 tasks

agatha197 mentioned this pull request May 19, 2026

docs: remove outdated add_registry_dialog screenshot from container registry section #7487

Merged

2 tasks

ironAiken2 force-pushed the 05-15-docs_model-serving_update_for_deployment-only_create_modal_revision_ux_and_detail_page_polish branch from 47bc665 to c5932db Compare May 19, 2026 08:00

ironAiken2 force-pushed the graphite-base/7443 branch from dcc10dc to be9b9dd Compare May 19, 2026 08:00

ironAiken2 changed the base branch from graphite-base/7443 to 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual May 19, 2026 08:00

agatha197 force-pushed the 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual branch from be9b9dd to dcc10dc Compare May 19, 2026 08:34

agatha197 force-pushed the 05-15-docs_model-serving_update_for_deployment-only_create_modal_revision_ux_and_detail_page_polish branch from c5932db to 47bc665 Compare May 19, 2026 08:34

agatha197 mentioned this pull request May 19, 2026

docs(FR-2924): capture upload-disabled and cascading-delete-warning vfolder screenshots #7489

Merged

3 tasks

graphite-app Bot force-pushed the 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual branch from dcc10dc to 1a6ba8b Compare May 19, 2026 15:17

graphite-app Bot force-pushed the 05-15-docs_model-serving_update_for_deployment-only_create_modal_revision_ux_and_detail_page_polish branch from 47bc665 to 39db375 Compare May 19, 2026 15:18

Base automatically changed from 05-15-docs_rename_wsproxy_to_app_proxy_across_the_manual to main May 19, 2026 15:23

graphite-app Bot merged commit 39db375 into main May 19, 2026
4 checks passed

graphite-app Bot deleted the 05-15-docs_model-serving_update_for_deployment-only_create_modal_revision_ux_and_detail_page_polish branch May 19, 2026 15:25

github-pages Bot had a problem deploying to github-pages May 19, 2026 15:25 Error

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish#7443

docs(model-serving): update for deployment-only create modal, revision UX, and detail page polish#7443
graphite-app[bot] merged 1 commit into
mainfrom
05-15-docs_model-serving_update_for_deployment-only_create_modal_revision_ux_and_detail_page_polish

yomybaby commented May 16, 2026 •

edited by agatha197

Loading

Uh oh!

yomybaby commented May 16, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

agatha197 left a comment

Uh oh!

graphite-app Bot commented May 19, 2026 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

yomybaby commented May 16, 2026 • edited by agatha197 Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yomybaby commented May 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

How to use the Graphite Merge Queue

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

agatha197 left a comment

Choose a reason for hiding this comment

Uh oh!

graphite-app Bot commented May 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Merge activity

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

yomybaby commented May 16, 2026 •

edited by agatha197

Loading

yomybaby commented May 16, 2026 •

edited

Loading

graphite-app Bot commented May 19, 2026 •

edited

Loading