-
Notifications
You must be signed in to change notification settings - Fork 20
fix(studio): update documentation #1499
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
dmariali
wants to merge
2
commits into
main
Choose a base branch
from
documentation-update-nvbug
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| --- | ||
| # SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| title: "Plugin UIs in NeMo Studio" | ||
| description: "Find and use Studio pages contributed by installed NeMo Platform plugins." | ||
| --- | ||
|
|
||
| NeMo Platform plugins can contribute pages to Studio at runtime. A plugin UI runs inside Studio and shares the current workspace, navigation, authentication, notifications, and visual theme. You do not open a separate application. | ||
|
|
||
| Plugin entries only appear when all of the following are true: | ||
|
|
||
| - The plugin is installed and registered with NeMo Platform. | ||
| - The plugin includes a Studio web bundle. | ||
| - Studio can load the platform's plugin manifest. | ||
|
|
||
| A plugin chooses where its entry appears. It can join a built-in group such as **Governance** or **Data**, or add its own sidebar group. Consequently, the navigation in one deployment can differ from another deployment of the same Studio version. | ||
|
|
||
| ## Iron Swarm | ||
|
|
||
| When the Iron Swarm plugin is installed, open its Studio UI from **Governance > Iron Swarm**. The entry is supplied by the plugin and does not require a separate Studio feature flag. | ||
|
|
||
| Iron Swarm runs an attack, defend, and validate war-game against a sandboxed copy of an agent. The UI lets you: | ||
|
|
||
| - View war-game runs and their status. | ||
| - Open a run to inspect progress and results. | ||
| - View, create, edit, and delete saved target manifests. | ||
| - Start a war-game from a saved manifest. | ||
|
|
||
| The plugin and its runtime prerequisites must be configured before a run can succeed. If **Iron Swarm** is absent, ask the platform administrator whether the plugin is installed and registered. If the entry is present but a run cannot start, check the plugin setup and health from the NeMo CLI. | ||
|
|
||
| ## Version and Availability | ||
|
|
||
| Plugin UIs are released with their plugins and can evolve independently of Studio's built-in pages. When a plugin page differs from this documentation, compare the NeMo Platform version and installed plugin version, and use the plugin's CLI documentation for detailed setup and troubleshooting. | ||
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.