Skip to content

docs: add endpoint detail page revision info, alert banners, and edit behavior docs#6767

Open
agatha197 wants to merge 1 commit into04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_from
docs/add-endpoint-detail-revision-info-alerts
Open

docs: add endpoint detail page revision info, alert banners, and edit behavior docs#6767
agatha197 wants to merge 1 commit into04-16-docs_fr-2571_document_model_store_v2_and_auto_scaling_rules_v2_26.4.0_from
docs/add-endpoint-detail-revision-info-alerts

Conversation

@agatha197
Copy link
Copy Markdown
Contributor

Resolves #6766

Summary

  • Add Revision Info card section (fields, mismatch state, View Current Revision modal) with screenshots
  • Document 3 alert banners (Preparing, Service Ready, Not In Project) with i18n-accurate labels per language
  • Clarify edit behavior distinction: model definition (Custom) vs runtime parameters (vLLM/SGLang)
  • Fix hardcoded English UI labels in KO/JA/TH translations to use proper i18n values
  • Remove Sync Routes references from all 4 languages
  • Recapture broken screenshots (service_launcher3, service_launcher_runtime_params) in English light mode
  • Add 4 new endpoint detail screenshots across all 4 language directories

Copy link
Copy Markdown
Contributor Author

agatha197 commented Apr 16, 2026

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.
Learn more


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 updates the Model Serving “endpoint detail” documentation across languages, adding new sections (revision info, alert banners, edit behavior clarification) and updating screenshots; it also includes a substantial update to data/schema.graphql.

Changes:

  • Added Endpoint Detail Page docs: contextual alert banners, “Revision Info” card (mismatch state + “View Current Revision” modal), and clarified edit behavior for Custom vs vLLM/SGLang.
  • Updated/added screenshots (e.g., service_launcher3.png, endpoint_service_ready_alert.png, endpoint_revision_mismatch.png) across multiple language image directories.
  • Updated GraphQL schema with new/changed types/fields/mutations/queries (e.g., deployment revision refresh, query preset categories, deployment revision fields).

Reviewed changes

Copilot reviewed 5 out of 29 changed files in this pull request and generated no comments.

Show a summary per file
File Description
packages/backend.ai-webui-docs/src/en/model_serving/model_serving.md Adds alert banner + revision-info + route error modal docs; adds runtime-variant comparison table.
packages/backend.ai-webui-docs/src/ko/model_serving/model_serving.md Same doc additions; includes runtime-variant comparison table.
packages/backend.ai-webui-docs/src/ja/model_serving/model_serving.md Same doc additions (no runtime-variant comparison table).
packages/backend.ai-webui-docs/src/th/model_serving/model_serving.md Same doc additions (no runtime-variant comparison table).
packages/backend.ai-webui-docs/src/en/images/service_launcher3.png Adds updated screenshot asset.
packages/backend.ai-webui-docs/src/ko/images/service_launcher3.png Adds updated screenshot asset.
packages/backend.ai-webui-docs/src/ja/images/service_launcher3.png Adds updated screenshot asset.
packages/backend.ai-webui-docs/src/th/images/service_launcher3.png Adds updated screenshot asset.
packages/backend.ai-webui-docs/src/en/images/endpoint_service_ready_alert.png Adds new alert banner screenshot asset.
packages/backend.ai-webui-docs/src/ko/images/endpoint_service_ready_alert.png Adds new alert banner screenshot asset.
packages/backend.ai-webui-docs/src/ja/images/endpoint_service_ready_alert.png Adds new alert banner screenshot asset.
packages/backend.ai-webui-docs/src/th/images/endpoint_service_ready_alert.png Adds new alert banner screenshot asset.
packages/backend.ai-webui-docs/src/en/images/endpoint_revision_mismatch.png Adds revision-mismatch screenshot asset.
packages/backend.ai-webui-docs/src/ko/images/endpoint_revision_mismatch.png Adds revision-mismatch screenshot asset.
packages/backend.ai-webui-docs/src/ja/images/endpoint_revision_mismatch.png Adds revision-mismatch screenshot asset.
packages/backend.ai-webui-docs/src/th/images/endpoint_revision_mismatch.png Adds revision-mismatch screenshot asset.
data/schema.graphql Adds/changes GraphQL schema for deployment revisions + query preset categories + other related fields.

@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
@agatha197 agatha197 force-pushed the docs/add-endpoint-detail-revision-info-alerts branch from 1e9e57c to 56dbd79 Compare April 16, 2026 14:51
@agatha197 agatha197 requested a review from nowgnuesLee April 16, 2026 14:56
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`).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XL 500~ LoC

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants