You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/cloud/catalog/exploring-the-catalog.md
+27-25Lines changed: 27 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,22 @@
1
1
---
2
-
title: Catalog Management
2
+
title: Exploring the Catalog
3
3
weight: 3
4
4
description: "A guide to managing items in the Meshery Catalog. Learn how to view, filter, edit, unpublish, delete, download, and clone your designs."
5
5
categories: [Catalog]
6
6
tags: [Designer]
7
7
---
8
8
9
-
The [Meshery Catalog](https://cloud.layer5.io/catalog)serves as your central hub for well-architected cloud native patterns and best practices templates. Here, you can browse, discover, and share designs with the wider community.
9
+
The [Meshery Catalog](https://cloud.layer5.io/catalog)is the central hub for well-architected cloud native patterns and best practices templates. Here, you can browse, discover, and share designs with the wider community.
10
10
11
11
12
12
13
13
## Viewing Catalog Items
14
14
15
-
The main catalog page displays all available designs in an organized, searchable format.
15
+
The Cloud Catalog displays all available designs in an organized, searchable format.
16
16
17
17
### Top Performers
18
-
At the top of the Catalog page, you'll find the **Top Performers** section. This provides a snapshot of the full Leaderboard, highlighting the most popular designs based on various [metrics](/cloud/catalog/metrics/).
18
+
19
+
At the top of the page, you can find the **Top Performers** section. This provides a snapshot of the full Leaderboard, highlighting the most popular designs based on various [metrics](/cloud/catalog/metrics/).
19
20
- To see the complete rankings, click the **Open Leaderboard** button.
20
21
- You can toggle the visibility of this section using the **Hide Performers** / **Show Performers** button.
21
22
@@ -25,60 +26,61 @@ To learn more about Leaderboard, see the [Leaderboard documentation](/cloud/cata
25
26
26
27
### Grid View
27
28
28
-
The grid view offers a visual, card-based layout that's ideal for browsing designs by their visual appearance. Each card provides key information at a glance:
29
+
The grid view offers a visual, card-based layout that's ideal for browsing designs by their thumbnail.
29
30
31
+
Each card provides key information at a glance:
30
32
-**Class:** The banner in the top-left corner shows the design's classification (e.g., Official)
31
33
-**Type:** The tag in the top-right corner indicates the design's category (e.g., Deployment)
32
34
-**Metrics:** A row of icons at the bottom displays key usage statistics (Opens, Downloads, Deploys, Clones, Shares)
33
35
-**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
34
36
35
-
To better understand what these Metrics represent, you can learn more about [design metrics](/cloud/catalog/metrics/).
39
41
{{< /alert >}}
40
42
41
43
### Table View
42
44
43
-
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.
45
+
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.
46
48
47
-
{{< alert type="info" title="Choose Your Preferred View" >}}
48
-
Both the grid and table views provide the same set of management capabilities, so you can pick the layout that best suits your task.
The filter bar on the left helps you narrow down the catalog to find exactly what you need. You can sort the entire catalog or apply specific filters.
54
54
55
-
####Sort By
55
+
### Sort By
56
56
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.
57
57
58
-
####Owner
58
+
### Owner
59
59
Filter designs based on their owner, whether it's your entire Organization, specific Teams, or an individual Author.
60
60
61
61
### Class
62
62
63
-
The `Class` filter helps you find content based on its level of support and verification:
63
+
The **Class** filter helps you find content based on its level of verification:
64
64
-**Official:** Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable.
65
65
-**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.
66
66
-**Community:** Content produced and shared by Meshery users. This includes a wide range of content with varying levels of support and reliability.
67
67
68
-
####Technology and Type
68
+
### Technology and Type
69
69
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.
70
70
-**Technology:** A list of technologies included in the design, like `Argo CD`, `AWS API Gateway`, or `Apache ShardingSphere`.
71
71
-**Type:** The category of the design, such as `deployment`, `observability`, `resiliency`, or `traffic-management`.
72
72
73
73
## Viewing Design Details
74
74
75
-
When you click on any design in the catalog, 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.
75
+
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.
-**Class, Created By, and Dates:** See the design's classification (e.g., Official), its original author, and when it was created and last updated
81
+
-**Class, Created By, and Dates:** See the design's class, its original author, and when it was created and last updated
80
82
-**Version:** The design's version number. This increments automatically each time the design is updated
81
-
-**Visibility:** The status of the design. For all items found in the public catalog, this will be Published
83
+
-**Visibility:** The status of the design. For all items found in the public catalog, this will be **Published**
82
84
83
85
As you scroll down the page, you will find other useful sections:
84
86
@@ -104,31 +106,31 @@ When you clone a design:
104
106
105
107
### Download
106
108
107
-
The **Download** button allows you to save the design to your local machine as a `Meshery Design (YAML)` file. This is useful for offline backups, version control with Git, or sharing the file directly.
109
+
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.
108
110
109
111
> 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/).
110
112
111
113
### Edit
112
114
113
-
After you've published a design, you might need to update its metadata or descriptive information. Clicking the **Edit** button opens a modal window where you can make your changes.
115
+
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.
Some properties of a published design are immutable and cannot be changed through the edit screen:
126
+
Some properties of a published design are immutable and cannot be changed:
125
127
-**Name:** The original name of the published design cannot be modified
126
-
-**Visibility:** You cannot change a published design's visibility directly. To remove it from public view, you must **Unpublish**the item instead
128
+
-**Visibility:** You cannot change a published design's visibility directly. To remove it from public view, you must **Unpublish**it instead
127
129
{{< /alert >}}
128
130
129
131
### Unpublish
130
132
131
-
If you no longer want a design to be publicly visible in the catalog, you can use the **Unpublish** button. This action removes the design from the public catalog but does not delete it. It will remain in your workspace as a private design.
133
+
If you no longer want a design to be publicly visible in the catalog, you can use the **Unpublish** button. This action removes the design from the public catalog but does not delete it. It will remain be your design as a private design.
Editing/Unpublish catalog items requires specific user roles and permissions. Learn more: [Default Permissions documentation](/cloud/reference/default-permissions/).
0 commit comments