Skip to content

Docs: Introduce Exploring the Catalog Section & Update Metrics/Leaderboard #618

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

Merged
merged 13 commits into from
Jul 1, 2025
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
2 changes: 2 additions & 0 deletions content/en/cloud/catalog/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Catalog
weight: 5
description: >
The Cloud Catalog is a web-based, public catalog to facilitate easy sharing and discovery of common cloud native architectures and design patterns.
categories: [Catalog]
tags: [Designer]
---

{{%pageinfo%}}
Expand Down
139 changes: 139 additions & 0 deletions content/en/cloud/catalog/exploring-the-catalog.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
---
title: Exploring the Catalog
weight: 3
description: "Discover how to browse, find, and interact with designs in the Catalog."
categories: [Catalog]
tags: [Designer]
---

[Meshery Catalog](https://cloud.layer5.io/catalog) is the central hub for well-architected cloud native patterns and best practices templates. Here, you can discover and share designs with the wider community.

![Catalog main page view](/cloud/catalog/images/catalog-view.gif)

## Viewing Catalog Items

Meshery Catalog displays all published designs in an organized, searchable format.

### Top Performers

At the top of the page, you can find the **Top Performers** section. This provides a snapshot of the **Leaderboard**, highlighting the most popular designs based on various [metrics](/cloud/catalog/metrics/).
- To see the complete rankings, click the **Open Leaderboard** button.
- You can toggle the visibility of this section using the **Hide Performers** / **Show Performers** button.

{{< alert type="info" title="Learn More About Leaderboard" >}}
To learn more about Leaderboard, see the [Leaderboard documentation](/cloud/catalog/leaderboard/).
{{< /alert >}}

### Grid View

The grid view offers a visual, card-based layout that's ideal for browsing designs by their thumbnail.

Each card provides key information at a glance:
- **Class:** The banner in the top-left corner shows the design's classification (e.g., Official)
- **Type:** The tag in the top-right corner indicates the design's category (e.g., Deployment)
- **Metrics:** A row of icons at the bottom displays key usage statistics (Opens, Downloads, Deploys, Clones, Shares)
- **Detailed Information (on hover):** When you hover over a card, it flips to reveal more details, including the author, design version, technologies used, and the last updated time

<img src="/cloud/catalog/images/card-view.png" alt="Card View" style="width: 40%" />

{{< alert type="info" title="Understanding Design Metrics" >}}
To better understand what these Metrics represent, you can learn more about [design metrics](/cloud/catalog/metrics/).
{{< /alert >}}

### Table View

Table view provides a dense, list-based format that's ideal for sorting and comparing items based on specific metrics.

To customize the information displayed in this view, click the **View Columns icon** and select the attributes you want to see, such as Author, Created At, or Downloads.

![Catalog table view](/cloud/catalog/images/design-view.gif)

## Filtering and Sorting Catalog Items

The filter bar helps you narrow down the catalog to find exactly what you need. You can sort the entire catalog or apply specific filters.

### Sort By
You can order all items in the catalog based on different criteria, such as alphabetically, by most recently updated, or by popularity metrics like most cloned or downloaded.

### Owner
Filter designs based on their owner, whether it's your entire Organization, specific Teams, or an individual Author.

### Class

The **Class** filter helps you find content based on its level of verification:
- **Official:** Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable.
- **Verified:** Content produced by partners and verified by Meshery maintainers. While not directly maintained by Meshery, it has undergone a verification process to ensure quality and compatibility.
- **Community:** Content produced and shared by Meshery users. This includes a wide range of content with varying levels of support and reliability.

### Technology and Type
These filters correspond to the metadata authors provide when they publish designs. They allow you to find items based on the technologies they use or the function they perform.
- **Technology:** A list of technologies included in the design, like `Argo CD`, `AWS API Gateway`, or `Apache ShardingSphere`.
- **Type:** The category of the design, such as `deployment`, `observability`, `resiliency`, or `traffic-management`.

## Viewing Design Details

When you click on any design, you'll see its detail page. This page provides a complete overview of the design's purpose, technical details, and how you can use it.

![Catalog modal](/cloud/catalog/images/design_model.png)

### Key Information

- **Class, Created By, and Dates:** See the design's class, its original author, and when it was created and last updated.
- **Version:** The design's version number. This increments automatically each time the design is updated.
- **Visibility:** The status of the design. For all designs found in the public catalog, this will be **Published**.

As you scroll down the page, you will find other useful sections:

- **Caveats and Considerations:** Specific stipulations to consider and known behaviors to be aware of when using this design.
- **Similar Designs by Type:** At the bottom, other designs of the same type, helping you discover other relevant patterns.

## Available Actions

### Open in Playground

Clicking **Open in Playground** loads the design directly into [Kanvas](https://kanvas.new/).

### Clone

Cloning creates a personal, editable copy of the design in your own workspace. This is useful when you want to use an existing public design as a starting point for your own customizations.

When you clone a design:
- The new copy will appear in your **[My Designs](https://cloud.layer5.io/catalog/content/my-designs)** tab.
- Its name will be appended with `(Copy)` to distinguish it from the original.
- The visibility of the cloned design is set to **Private** by default, so only you can see it until you decide to publish it.

### Download

The **Download** button allows you to save the design as a `Meshery Design (YAML)` file. This is useful for offline backups or sharing the file directly.

> For more advanced use cases, Meshery also supports exporting designs into other formats. To learn more, see the guide on [Exporting Designs](/kanvas/designer/export-designs/).

{{< alert type="warning" title="Metadata Not Included in Download" >}}
Design downloads include only the core YAML definition, excluding associated catalog metadata such as descriptions, technology, or class.
{{< /alert >}}

### Edit

After you've published a design, you might need to update its metadata or description. Clicking the **Edit** button opens a dialog where you can make your changes.

![Design edit modal](/cloud/catalog/images/design-edit.png)

You can modify the following fields:
- **Type:** Change the design's category.
- **Technology:** Add or remove associated technology tags.
- **Description:** Update the main purpose and intended uses of the design.
- **Caveats and Considerations:** Revise any special stipulations or known behaviors.

{{< alert type="warning" title="Immutable Properties" >}}
Some properties of a published design are immutable and cannot be changed:
- **Name:** The original name of the published design cannot be modified.
- **Visibility:** You cannot change a published design's visibility directly. To remove it from the catalog, you must **Unpublish** it instead.
{{< /alert >}}

### Unpublish

If you no longer want a design to be published in the catalog, you can use the **Unpublish** button. This action will remove the design from Meshery Catalog but does **not delete** it. The design will remain as a private design in your account.

{{< alert type="info" title="Permissions Required" >}}
Editing/Unpublish published designs requires specific user roles and permissions. Learn more: [Default Permissions documentation](/cloud/reference/default-permissions/).
{{< /alert >}}
Binary file added content/en/cloud/catalog/images/card-view.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/en/cloud/catalog/images/cards.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/cloud/catalog/images/catalog-view.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/cloud/catalog/images/design-edit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/cloud/catalog/images/design-view.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added content/en/cloud/catalog/images/design_model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/en/cloud/catalog/images/leaderboard.png
Binary file not shown.
Binary file modified content/en/cloud/catalog/images/leaderboard_button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed content/en/cloud/catalog/images/modal.png
Binary file not shown.
Binary file not shown.
25 changes: 16 additions & 9 deletions content/en/cloud/catalog/leaderboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,27 +3,34 @@ title: Leaderboard
weight: 2
description: >
The Leaderboard is a visual representation of Designs, ranked based on key Metrics such as Opens, Downloads, Deployments, Clones, and Shares.
categories: [Catalog]
tags: [Designer]
---

Leaderboard provides a clear and engaging way to view and compare the performance of different Designs, highlighting the most popular and actively used ones within the Cloud.

![Leaderboard page overview](/cloud/catalog/images/leaderboard-page.gif)

{{< alert title="Note" >}}

{{< alert type="info" title="Understanding Metrics" >}}
Metrics are quantifiable measures used to track and assess the status, progress, and performance of various activities and user interactions with Designs. Learn more about [Metrics](/cloud/catalog/metrics/)

{{< /alert >}}

### How to Access the Leaderboard

1. Open the design catalog on the _Layer5 Cloud_ catalog page at [Layer5 Cloud Catalog](https://cloud.layer5.io/catalog).
You can reach the Leaderboard page in two ways:

1. **Global Navigation Bar:** Click the Leaderboard icon in the main navigation bar for quick access.
2. **From the Catalog Page:** While Browse the Catalog, you can click the 'Open Leaderboard' button in the **Top Performers** section

2. By clicking on the Leaderboard icon button, you will be redirected to the [Leaderboard](https://cloud.layer5.io/catalog/leaderboard) page.
![Leaderboard Button](/cloud/catalog/images/leaderboard_button.png)

3. The Leaderboard page will show you the top 10 designs based on the Metrics.
![Leaderboard](/cloud/catalog/images/leaderboard.png)
### Using the Leaderboard Page

The Leaderboard page offers several ways to explore and interact with:

You can also hide or unhide the columns of the leaderboard using the View Columns button.
![View Leaderboard](/cloud/catalog/images/view_leaderboard.png)
- **Search for Designs:** Click the **Search** icon to quickly find specific designs by name.
- **Sort by Different Metrics:** Click on column headers like `Opens`, `Clones`, or `Downloads` to reorder the list based on your preferred metric.
- **Customize Your View:** Click the **View Columns** icon to show or hide specific metric columns.
- **Take Actions:** Click the **Actions** icon to download, share, or perform other actions.

![Leaderboard action menu](/cloud/catalog/images/leaderboard-action.png)
8 changes: 5 additions & 3 deletions content/en/cloud/catalog/metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@ title: Metrics
weight: 1
description: >
Metrics are quantifiable measures used to track and assess the status, progress, and performance of various activities and user interactions with Designs.
categories: [Catalog]
tags: [Designer]
---

Metrics provide valuable insights into how users engage with the designs, allowing us to understand usage patterns, identify trends, and make data-driven decisions to improve the user experience.

The design catalog can be accessed from the _Layer5 Cloud_ catalog page at [Layer5 Cloud Catalog](https://cloud.layer5.io/catalog).

{{< alert title="Note" >}}
{{< alert type="info" title="Design Capabilities" >}}

Designs can be imported, exported, versioned, forked, merged, snapshotted, published, shared, embedded, templatized, and more. Learn more about [Designs](/kanvas/getting-started/)

Expand All @@ -20,7 +22,7 @@ You can view the metrics of a Design in two ways:
![Catalog card](/cloud/catalog/images/cards.png)

2. By clicking on the catalog card, a modal will pop up displaying all the information about the Design, including its metrics.
![Catalog modal](/cloud/catalog/images/modal.png)
![Catalog modal](/cloud/catalog/images/design_model.png)

Here’s a detailed explanation of each metric we track:

Expand All @@ -30,7 +32,7 @@ This metric helps us understand how often users are viewing a particular design.
##### 2. Downloads
Downloads provide insights into the popularity and demand for a design.

##### 3. Deployments
##### 3. Deploys
This metric shows how often a design is implemented or put into action.

##### 4. Clones
Expand Down