Skip to content

Commit

Permalink
adding package catalog docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leoporoli committed Jan 3, 2024
1 parent 3cc68eb commit 8f22145
Showing 1 changed file with 39 additions and 0 deletions.
39 changes: 39 additions & 0 deletions docs/docs/get-started/package-catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: Package catalog
sidebar_label: Basic Concepts
slug: '/package-catalog'
sidebar_position: 6
---

Package catalog
---------------

The Kurtosis package catalog if the public repository of Kurtosis packages where package authors can publish their packages which later can be found and used by any user.

The catalog address is [catalog.kurtosis.com][package-catalog]


How can authors add a new package into the catalog?
---------------------------------------------------

The catalog is made up of a curated list that is stored in the `kurtosis-package-catalog.yml` file within the [kurtosis-package-catalog repository.][package-catalog-repository]

If an author wants to add their package to the catalog, they should add its name on the list inside the `kurtosis-package-catalog.yml` file and send a pull request to be validated by the CI validations and approved by a Kurtosis administrator.

### What validates the CI?

The CI's automatic jobs validate the following for each new Pull Request created:

- That there are no duplicated names within the `kurtosis-package-catalog.yml` file, there cannot be two or more packages with the same name.
- That the package repository exists.
- That the repository contains the `kurtosis.yml` file.
- That the name declared in the `kurtosis.yml` file corresponds to the name that is being added to the catalog
- Only if the package contains an icon (you should upload an image file named `kurtosis-package-icon.png` in your package repository, at the same level as the `kurtosis.yml` file, is if you want to add an icon to be displayed in the catalog)
- It will be validated that its size is greater than 120px
- It will be validated that its size is less than 1024px
- If it validated that it contains a 1:1 aspect ratio, a square image.

If the package does not pass these validations, you should make the necessary modifications until it is validated and then approved and added to the catalog.

[package-catalog]: https://catalog.kurtosis.com/
[package-catalog-repository]: https://github.com/kurtosis-tech/kurtosis-package-catalog

0 comments on commit 8f22145

Please sign in to comment.