Skip to content
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

Add documentation about auto-adding source bucket #4258

Merged
merged 5 commits into from
Dec 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 11 additions & 1 deletion docs/Catalog/Preferences.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,18 @@ ui:
defaultSourceBucket: s3://bucket-b
```

Note that the `ui.sourceBuckets` is empty by default.
As a result, when users create or revise a package in a new bucket
they can't add files from any bucket, including that one.
Instead, you need to manually add a configuration file,
or click "auto-add current bucket"
(which will create or edit the configuration file to add
the current bucket to the list of `ui.sourceBuckets`)

![Users can auto-add the current bucket to ui.sourceBuckets](../imgs/auto-add-source-bucket.png)

#### `ui.package_description` example

```yaml
ui:
package_description:
Expand Down
Binary file added docs/imgs/auto-add-source-bucket.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading