Skip to content

docs(FR-2571): document Model Store V2 and Auto Scaling Rules V2 (26.4.0+)#6760

Merged
graphite-app[bot] merged 1 commit intomainfrom
04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_
Apr 22, 2026
Merged

docs(FR-2571): document Model Store V2 and Auto Scaling Rules V2 (26.4.0+)#6760
graphite-app[bot] merged 1 commit intomainfrom
04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_

Conversation

@nowgnuesLee
Copy link
Copy Markdown
Contributor

Stacked on top of PR #6708 (the excl. model store PR). Completes the FR-2571 docs work by documenting the Model Store V2 and Auto Scaling Rules V2 surfaces that were intentionally deferred from #6708.

Structural approach

Decided with the user: document both legacy and V2 paths side-by-side, split by explicit Backend.AI manager version. Legacy prose stays in place as-is; V2 is appended as a versioned #### subsection with a :::note admonition pointing from the legacy block to the new block. No <details> collapsibles — both variants are equally visible.

The structural pattern used in every affected section:

### Section Heading

<legacy prose — kept, with legacy screenshot>

:::note
From Backend.AI version 26.4.0 onwards, this section has been redesigned. If
you are on an older version, the description above still applies. Otherwise,
refer to [Section (version 26.4.0 and later)](#section-version-26-4-0-and-later) below.
:::

<a id="section-version-26-4-0-and-later"></a>

#### Section (version 26.4.0 and later)

<V2 prose with new V2 screenshot>

Version resolution

Backend.AI manager 26.4.0 is the cutover version for both V2 surfaces. Verified at:

  • src/lib/backend.ai-client-esm.ts:895–904model-card-v2 (line 901) and prometheus-auto-scaling-rule (line 903) are both gated on isManagerVersionCompatibleWith('26.4.0').
  • .specs/draft-auto-scaling-rule-ux/spec.md:48 — auto-scaling spec explicitly states >=26.4.0.
  • .specs/model-store-v2-migration/dev-plan.md:13-25 — same manager version for model-store V2.

Changes (applied identically across en / ko / ja / th)

model_serving.md — three V2 subsections appended

  1. ### Auto Scaling Rules#### Auto Scaling Rules (version 26.4.0 and later): new Prometheus metric source with preset + live preview, Single/Range condition segmented control with directional threshold, Time Window (replaces legacy CoolDown Seconds), Step Size as positive integer with contextual sign prefix, separate Min/Max Replicas fields, property filters + pagination + Last Triggered column, inline Edit/Delete on Condition cell.
  2. ## Model Store### Model Store (version 26.4.0 and later): search+sort layout (replaces Category/Task/Label dropdowns), card detail Drawer (replaces Modal), card 50%-opacity + Deploy-disabled state for zero-preset models, two-scenario Deploy flow (auto-deploy vs Deploy Model selection modal), explicit absence of Clone button with cross-page link to ../vfolder/vfolder.md.
  3. ### Admin Model Store Management#### Admin Model Store Management (version 26.4.0 and later): new column set (Name / Title / Category / Task / Access Level / Domain / Project / Created At — no Labels, no separate Controls column), Private / Public access tags, name-only property filter, inline Edit/Delete on Name cell via BAINameActionCell, row-selection bulk delete, explicit note that Scan Project Model Cards button is not available in 26.4.0+.

Ripple edits (3 sites augmented, not replaced)

  • ### Guide to Steps for Using Model Service :::tip block
  • ### Creating a Service Definition File (two references)

Pattern: Run this model button (Deploy on version 26.4.0 and later).

7 new V2 screenshots

Captured in English UI, copied byte-identically to all 4 language images/ dirs (MD5 verified).

  • auto_scaling_rules_v2.png
  • auto_scaling_rules_modal_v2.png (Kernel + Single)
  • auto_scaling_rules_modal_prometheus_v2.png (Prometheus preset + Range)
  • model_store_page_v2.png
  • model_card_detail_drawer.png
  • model_card_deploy_modal.png
  • admin_model_card_list_v2.png

Existing legacy screenshots (auto_scaling_rules.png, auto_scaling_rules_modal.png, model_store_page.png, model_card_detail_modal.png, model_clone_dialog.png, admin_model_card_list.png) are untouched and continue to document the legacy variants.

Bug fix

Broken cross-reference [Data](#data)[Data](../vfolder/vfolder.md) (relative cross-page link per project convention).

Structural parity verification

  • 43 headings per file, identical #-level sequences across en/ko/ja/th.
  • 3 English-only anchors (auto-scaling-rules-version-26-4-0-and-later, model-store-version-26-4-0-and-later, admin-model-store-management-version-26-4-0-and-later) present in all four files.
  • All 7 V2 image references identical across languages.
  • Legacy prose intact — only diffs outside the new V2 blocks are the 3 ripple-site rewrites.
  • book.config.yaml unchanged (no new top-level pages introduced).

Agent workflow

Planned via docs-update-planner → written via docs-update-writer → quality reviewed via docs-update-reviewer (18 auto-fixes applied: PUBLIC → Public tag casing, 3-space indented notes → :::note admonitions, Backend.AI version 26.4.0 prefix consistency) → screenshots via docs-screenshot-capturer.

Artifacts (in .agent-output/, gitignored):

  • docs-update-plan-model-store-and-autoscaling.md
  • docs-review-report-model-store-and-autoscaling.md

Checklist:

  • Documentation
  • Structural parity across en/ko/ja/th verified
  • Version number resolved (26.4.0) and referenced consistently
  • Cross-page links and image references verified
  • Legacy prose preserved; V2 subsections appended via :::note + anchor pattern
  • No TODO(needs-version) markers remain

🤖 Generated with Claude Code

Copilot AI review requested due to automatic review settings April 16, 2026 09:38
@github-actions github-actions Bot added the size:L 100~500 LoC label Apr 16, 2026
Copy link
Copy Markdown
Contributor Author

nowgnuesLee commented Apr 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

Documents the Backend.AI WebUI Model Store V2 and Auto Scaling Rules V2 (manager 26.4.0+) in the user manual while preserving the legacy UI documentation, applied consistently across en/ko/ja/th.

Changes:

  • Adds version-gated V2 subsections for Auto Scaling Rules, Model Store, and Admin Model Store Management (legacy + 26.4.0+ side-by-side with anchors and notes).
  • Updates “Run this model” button references to mention it is renamed to Deploy in 26.4.0+ and fixes the cross-page Data link.
  • Adds new V2 screenshots (copied across all language image directories).

Reviewed changes

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

Show a summary per file
File Description
packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md Adds 26.4.0+ V2 documentation blocks and updates button wording/linking in English.
packages/backend.ai-webui-docs/src/ko/model_serving/model_serving.md Same V2 doc blocks and ripple edits applied to Korean.
packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md Same V2 doc blocks and ripple edits applied to Japanese.
packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md Same V2 doc blocks and ripple edits applied to Thai.
packages/backend.ai-webui-docs/src/en/images/auto_scaling_rules_v2.png New screenshot for redesigned Auto Scaling Rules list (V2).
packages/backend.ai-webui-docs/src/en/images/auto_scaling_rules_modal_v2.png New screenshot for redesigned Auto Scaling Rule editor (V2).
packages/backend.ai-webui-docs/src/en/images/auto_scaling_rules_modal_prometheus_v2.png New screenshot showing Prometheus preset UX (V2).
packages/backend.ai-webui-docs/src/en/images/model_store_page_v2.png New screenshot for redesigned Model Store page (V2).
packages/backend.ai-webui-docs/src/en/images/model_card_detail_drawer.png New screenshot for model card detail drawer (V2).
packages/backend.ai-webui-docs/src/en/images/model_card_deploy_modal.png New screenshot for Deploy Model modal (V2).
packages/backend.ai-webui-docs/src/en/images/admin_model_card_list_v2.png New screenshot for Admin Model Store Management list (V2).
packages/backend.ai-webui-docs/src/ko/images/auto_scaling_rules_v2.png Korean copy of the V2 Auto Scaling Rules list screenshot.
packages/backend.ai-webui-docs/src/ko/images/auto_scaling_rules_modal_v2.png Korean copy of the V2 Auto Scaling Rule editor screenshot.
packages/backend.ai-webui-docs/src/ko/images/auto_scaling_rules_modal_prometheus_v2.png Korean copy of the Prometheus preset UX screenshot.
packages/backend.ai-webui-docs/src/ko/images/model_store_page_v2.png Korean copy of the V2 Model Store page screenshot.
packages/backend.ai-webui-docs/src/ko/images/model_card_detail_drawer.png Korean copy of the V2 drawer screenshot.
packages/backend.ai-webui-docs/src/ko/images/model_card_deploy_modal.png Korean copy of the V2 deploy modal screenshot.
packages/backend.ai-webui-docs/src/ko/images/admin_model_card_list_v2.png Korean copy of the V2 admin list screenshot.
packages/backend.ai-webui-docs/src/ja/images/auto_scaling_rules_v2.png Japanese copy of the V2 Auto Scaling Rules list screenshot.
packages/backend.ai-webui-docs/src/ja/images/auto_scaling_rules_modal_v2.png Japanese copy of the V2 Auto Scaling Rule editor screenshot.
packages/backend.ai-webui-docs/src/ja/images/auto_scaling_rules_modal_prometheus_v2.png Japanese copy of the Prometheus preset UX screenshot.
packages/backend.ai-webui-docs/src/ja/images/model_store_page_v2.png Japanese copy of the V2 Model Store page screenshot.
packages/backend.ai-webui-docs/src/ja/images/model_card_detail_drawer.png Japanese copy of the V2 drawer screenshot.
packages/backend.ai-webui-docs/src/ja/images/model_card_deploy_modal.png Japanese copy of the V2 deploy modal screenshot.
packages/backend.ai-webui-docs/src/ja/images/admin_model_card_list_v2.png Japanese copy of the V2 admin list screenshot.
packages/backend.ai-webui-docs/src/th/images/auto_scaling_rules_v2.png Thai copy of the V2 Auto Scaling Rules list screenshot.
packages/backend.ai-webui-docs/src/th/images/auto_scaling_rules_modal_v2.png Thai copy of the V2 Auto Scaling Rule editor screenshot.
packages/backend.ai-webui-docs/src/th/images/auto_scaling_rules_modal_prometheus_v2.png Thai copy of the Prometheus preset UX screenshot.
packages/backend.ai-webui-docs/src/th/images/model_store_page_v2.png Thai copy of the V2 Model Store page screenshot.
packages/backend.ai-webui-docs/src/th/images/model_card_detail_drawer.png Thai copy of the V2 drawer screenshot.
packages/backend.ai-webui-docs/src/th/images/model_card_deploy_modal.png Thai copy of the V2 deploy modal screenshot.
packages/backend.ai-webui-docs/src/th/images/admin_model_card_list_v2.png Thai copy of the V2 admin list screenshot.

Comment thread packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/ko/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/ko/model_serving/model_serving.md Outdated
Comment thread packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md Outdated
@agatha197 agatha197 force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from eca7dc0 to f02fa57 Compare April 16, 2026 14:47
@agatha197 agatha197 force-pushed the 04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_ branch from e014a1d to 2b1f91f Compare April 16, 2026 14:47
@agatha197 agatha197 force-pushed the 04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_ branch from 2b1f91f to 5dbb8e0 Compare April 16, 2026 14:51
yomybaby added a commit that referenced this pull request Apr 17, 2026
…ng sections and apply KO wording fixes

Resolves Sujin's feedback thread for PRs #6760 and #6767:

- Remove legacy (pre-26.4.0) sections: Auto Scaling Rules, Model Store (browsing/details/clone/run), Admin Model Store Management (create/edit/delete/scan). Promote the V2 subsections to main section content.
- Drop `:::note` version-gate blocks, `#### (version 26.4.0 and later)` headings, and associated HTML anchors now that only the 26.4.0 UI is documented.
- Remove the `Scan Project Model Cards` subsection entirely (no longer in UI).
- Rewrite Auto Scaling `Step Size` direction with explicit threshold formulas (`[minThreshold] < [metric]`, `[metric] < [maxThreshold]`, `[minThreshold] < [metric] < [maxThreshold]`) instead of prose about `+`/`-`/`±`.
- Korean translations:
  - Translate hardcoded 'No compatible presets available. This model cannot be deployed.' to Korean.
  - Apply 영어→한국어(영어) formatting consistency in Model Store field lists.
  - `Edit` → `수정` on Service Info card, routing-info alert, revision edit behavior note.
  - `Edit`/`Confirm` → `수정`/`업데이트` in Modifying a Service section.
- Rewrite `Access Level Internal` description across all languages: clarify that Internal is visible only to administrators of the owning domain and project.
- Simplify ripple references to the deploy button (`Run this model` (`Deploy` on 26.4.0) → `Deploy`) in EN/KO/JA/TH.
- Add TODO(Recapture) markers for images that still reference legacy or placeholder states (`auto_scaling_rules_v2.png`, `service_launcher_runtime_variant.png`).
@agatha197 agatha197 force-pushed the 04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_ branch from 5dbb8e0 to a78a74d Compare April 21, 2026 10:23
@agatha197 agatha197 force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from f02fa57 to 0878891 Compare April 21, 2026 10:23
@ironAiken2 ironAiken2 force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from 0878891 to 6a6fc73 Compare April 22, 2026 03:31
@ironAiken2 ironAiken2 force-pushed the 04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_ branch from a78a74d to 6418d8a Compare April 22, 2026 03:31
@graphite-app
Copy link
Copy Markdown

graphite-app Bot commented Apr 22, 2026

Merge activity

…4.0+) (#6760)

Stacked on top of PR #6708 (the `excl. model store` PR). Completes the FR-2571 docs work by documenting the Model Store V2 and Auto Scaling Rules V2 surfaces that were intentionally deferred from #6708.

## Structural approach

Decided with the user: document **both legacy and V2 paths side-by-side, split by explicit Backend.AI manager version**. Legacy prose stays in place as-is; V2 is appended as a versioned `####` subsection with a `:::note` admonition pointing from the legacy block to the new block. No `<details>` collapsibles — both variants are equally visible.

The structural pattern used in every affected section:

```markdown
### Section Heading

<legacy prose — kept, with legacy screenshot>

:::note
From Backend.AI version 26.4.0 onwards, this section has been redesigned. If
you are on an older version, the description above still applies. Otherwise,
refer to [Section (version 26.4.0 and later)](#section-version-26-4-0-and-later) below.
:::

<a id="section-version-26-4-0-and-later"></a>

#### Section (version 26.4.0 and later)

<V2 prose with new V2 screenshot>
```

## Version resolution

**Backend.AI manager 26.4.0** is the cutover version for both V2 surfaces. Verified at:

- `src/lib/backend.ai-client-esm.ts:895–904` — `model-card-v2` (line 901) and `prometheus-auto-scaling-rule` (line 903) are both gated on `isManagerVersionCompatibleWith('26.4.0')`.
- `.specs/draft-auto-scaling-rule-ux/spec.md:48` — auto-scaling spec explicitly states `>=26.4.0`.
- `.specs/model-store-v2-migration/dev-plan.md:13-25` — same manager version for model-store V2.

## Changes (applied identically across en / ko / ja / th)

### `model_serving.md` — three V2 subsections appended

1. **`### Auto Scaling Rules` → `#### Auto Scaling Rules (version 26.4.0 and later)`**: new Prometheus metric source with preset + live preview, Single/Range condition segmented control with directional threshold, Time Window (replaces legacy CoolDown Seconds), Step Size as positive integer with contextual sign prefix, separate Min/Max Replicas fields, property filters + pagination + Last Triggered column, inline Edit/Delete on Condition cell.
2. **`## Model Store` → `### Model Store (version 26.4.0 and later)`**: search+sort layout (replaces Category/Task/Label dropdowns), card detail Drawer (replaces Modal), card 50%-opacity + Deploy-disabled state for zero-preset models, two-scenario Deploy flow (auto-deploy vs Deploy Model selection modal), explicit absence of Clone button with cross-page link to `../vfolder/vfolder.md`.
3. **`### Admin Model Store Management` → `#### Admin Model Store Management (version 26.4.0 and later)`**: new column set (Name / Title / Category / Task / Access Level / Domain / Project / Created At — no Labels, no separate Controls column), `Private` / `Public` access tags, name-only property filter, inline Edit/Delete on Name cell via `BAINameActionCell`, row-selection bulk delete, explicit note that `Scan Project Model Cards` button is not available in 26.4.0+.

### Ripple edits (3 sites augmented, not replaced)

- `### Guide to Steps for Using Model Service` `:::tip` block
- `### Creating a Service Definition File` (two references)

Pattern: ``Run this model`` button (``Deploy`` on version 26.4.0 and later).

### 7 new V2 screenshots

Captured in English UI, copied byte-identically to all 4 language `images/` dirs (MD5 verified).

- `auto_scaling_rules_v2.png`
- `auto_scaling_rules_modal_v2.png` (Kernel + Single)
- `auto_scaling_rules_modal_prometheus_v2.png` (Prometheus preset + Range)
- `model_store_page_v2.png`
- `model_card_detail_drawer.png`
- `model_card_deploy_modal.png`
- `admin_model_card_list_v2.png`

Existing legacy screenshots (`auto_scaling_rules.png`, `auto_scaling_rules_modal.png`, `model_store_page.png`, `model_card_detail_modal.png`, `model_clone_dialog.png`, `admin_model_card_list.png`) are untouched and continue to document the legacy variants.

### Bug fix

Broken cross-reference `[Data](#data)` → `[Data](../vfolder/vfolder.md)` (relative cross-page link per project convention).

## Structural parity verification

- 43 headings per file, identical `#`-level sequences across en/ko/ja/th.
- 3 English-only anchors (`auto-scaling-rules-version-26-4-0-and-later`, `model-store-version-26-4-0-and-later`, `admin-model-store-management-version-26-4-0-and-later`) present in all four files.
- All 7 V2 image references identical across languages.
- Legacy prose intact — only diffs outside the new V2 blocks are the 3 ripple-site rewrites.
- `book.config.yaml` unchanged (no new top-level pages introduced).

## Agent workflow

Planned via `docs-update-planner` → written via `docs-update-writer` → quality reviewed via `docs-update-reviewer` (18 auto-fixes applied: PUBLIC → Public tag casing, 3-space indented notes → `:::note` admonitions, `Backend.AI version 26.4.0` prefix consistency) → screenshots via `docs-screenshot-capturer`.

Artifacts (in `.agent-output/`, gitignored):
- `docs-update-plan-model-store-and-autoscaling.md`
- `docs-review-report-model-store-and-autoscaling.md`

**Checklist:**
- [x] Documentation
- [x] Structural parity across en/ko/ja/th verified
- [x] Version number resolved (26.4.0) and referenced consistently
- [x] Cross-page links and image references verified
- [x] Legacy prose preserved; V2 subsections appended via `:::note` + anchor pattern
- [x] No `TODO(needs-version)` markers remain

🤖 Generated with [Claude Code](https://claude.com/claude-code)
@graphite-app graphite-app Bot force-pushed the 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ branch from 6a6fc73 to 5a3e5d8 Compare April 22, 2026 03:34
@graphite-app graphite-app Bot force-pushed the 04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_ branch from 6418d8a to c61698d Compare April 22, 2026 03:34
Base automatically changed from 04-15-docs_fr-2571_address_pr_6631_review_feedback_excl._model_store_ to main April 22, 2026 03:39
@graphite-app graphite-app Bot merged commit c61698d into main Apr 22, 2026
4 checks passed
@graphite-app graphite-app Bot deleted the 04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_ branch April 22, 2026 03:40
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.

3 participants