Voici Gallery

Contributing new examples

Create a repository with your notebook. You can start from the voici-demo example.
Create a PR to Voici gallery that modifies script/gallery.yaml file. You will need to fill in the following fields:
- title: the title used in the page thumbnail.
- description: the description used in the page thumbnail.
- repo_url: the URL of the repository containing the notebooks and resources used to build the Voici dashboard.
- content_path: the local path to the notebooks, this path will be passed to the --contents parameter of Voici command, default to .
- branch: the branch to be checked out from repo_url repository, default to main.
- dashboard_url: the URL of the deployed voici dashboard. If the voici dashboard is already deployed elsewhere you can use this field to bypass the build step. If you use this option, you do not need to provide the repo_url, content_path and the branch field.
- image_url: the URL of the picture to use as thumbnail.
- image_path: alternate way to provide your thumbnail image, by adding it to the public/images directory on this repository and providing the path in this parameter.
Once the PR is merged into main, the gallery is automatically redeployed and the new example will be visible shortly after.

See CONTRIBUTING.md for more detail on developing the gallery.