Skip to content

Document how to refresh component catalog entries #2997

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Nov 4, 2022
Merged

Document how to refresh component catalog entries #2997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/source/images/user_guide/pipeline-components/component-catalogs-ui.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 10 additions & 0 deletions docs/source/user_guide/pipeline-components.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,16 @@ To add components from a catalog:

> Tip: check the log file for error messages if no components from the added catalog are displayed in the palette.

#### Reloading a component catalog entry

To reload a catalog entry if the underlying catalog has changed:

1. Open the `Pipeline Components` panel.
1. Click the `reload` icon next to the entry name.
1. The catalog entry is re-loaded and changes are reflected in the Visual Pipeline Editor palette. How quickly the entry is processed depends on the catalog type, the number of entries in the catalog, and network connectivity.

> Tip: check the log file for error messages if no updates from the reloaded catalog are displayed in the palette.

#### Modifying a component catalog entry

1. Open the `Pipeline Components` panel.
Expand Down