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
[Meshery Catalog](https://cloud.layer5.io/catalog)Well-architectured cloud native patterns and best practices templates
10
+
[Meshery Catalog](https://cloud.layer5.io/catalog)is your central hub for well-architectured cloud native patterns and best practices templates. Here, you can browse, discover, and share infrastructure configurations with your team and the wider community.
11
11
12
-
Browse, discover, and share cloud native infrastructure configurations and patterns easily with Meshery Catalog.
12
+
13
13
14
-
## View Catalog
15
-
View all items in catalog
16
-
The is where you can see all of
14
+
## Viewing Catalog Items
15
+
The main catalog page is where you can see all available designs.
At the top of the Catalog page, you'll find the **Top Performers** section. Think of this as a snapshot of the full Leaderboard, highlighting the most popular designs based on various [metrics](https://docs.layer5.io/cloud/catalog/metrics/).
19
+
- To see the complete rankings, click the **Open Leaderboard** button.
20
+
- You can toggle the visibility of this section using the **Hide Performers** / **Show Performers** button.
20
21
21
-
/cloud/catalog/images/catalog-view.gif
22
+
{{< alert type="info" title="Learn More" >}}
23
+
To learn more about Leaderboard, see the [Leaderboard documentation](https://docs.layer5.io/cloud/catalog/leaderboard/).
24
+
{{< /alert >}}
25
+
26
+
### Grid View
27
+
The grid view offers a visual, card-based layout, which is great for Browse designs by their icons and high-level details. Each card in the grid is designed to give you key information at a glance:
28
+
-[**Class:**](#class) The banner in the top-left corner shows the design's classification (e.g., Official).
29
+
-**Type:** The tag in the top-right corner indicates the design's category (e.g., Deployment).
30
+
-**Metrics:** A row of icons at the bottom displays key usage statistics.
31
+
-**Detailed Information (on hover):** When you hover your mouse over a card, it flips to reveal more details, including the author, design version, technologies used, and the last updated time.
32
+
33
+
To better understand what these Metrics represent, you can learn more about [design metrics](https://docs.layer5.io/cloud/catalog/metrics/).
34
+
35
+
[](/images/card-view.png)
36
+
37
+
38
+
### Table View
39
+
Table view provides a dense, list-based format that is ideal for sorting and comparing items based on specific data points. 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.
40
+
41
+
22
42
23
-
#### Grid View
24
-
The grid view offers a card-based layout,
25
-
#### Table View
26
-
The table view provides a dense, list-based format that is ideal
27
-
To customize the information displayed, click the **View Columns** icon and select the attributes you want to see, such as Owner ID or Created Date.
28
-
{{< alert type="info" title="" >}}
29
-
Both the grid and table views provide the same set of management capabilities.选择合适的
43
+
{{< alert type="info" title="Choose Your View" >}}
44
+
Both the grid and table views provide the same set of management capabilities, so you can pick the layout that best suits your task.
30
45
{{< /alert >}}
31
46
32
-
### 左边是筛选栏
33
-
1. sort by：排序
34
-
2. owner：
35
-
3. class
36
-
official：Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable.
37
-
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.
38
-
community：Content produced and shared by Meshery users. This includes a wide range of content, such as performance profiles, test results, filters, patterns, and applications. Community content may have varying levels of support and reliability.
39
-
4. technology（A list of technologies included in or implicated by this design; a list of relevant technology tags.）和type（Categorization of the type of design or operational flow depicted in this design.），就是design在发布的时候填写的内容
40
-
41
-
Caveats and Considerations：
42
-
description：
43
-
44
-
Delete Catalog Items
45
-
？？？？
46
-
47
-
48
-
Edit Catalog Items
49
-
Edit catalog items
50
-
可以编辑
51
-
发布时候的名字不能改！
52
-
type
53
-
technology
54
-
description："Purpose of the design along with its intended and unintended uses."
55
-
caveals and consideratioos："Specific stipulations to consider and known behaviors to be aware of when using this design."
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.
50
+
51
+
#### Sort By
52
+
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.
53
+
54
+
#### Owner
55
+
Filter designs based on their owner, whether it's your entire Organization, specific Teams, or an individual Author.
56
+
57
+
#### Class
58
+
The `Class` filter helps you find content based on its level of support and verification:
59
+
-**Official:** Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable.
60
+
-**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.
61
+
-**Community:** Content produced and shared by Meshery users. This includes a wide range of content with varying levels of support and reliability.
62
+
63
+
#### Technology and Type
64
+
These filters correspond to the metadata auther provide when they publish designs. They allow you to find items based on the technologies they use or the function they perform.
65
+
-**Technology:** A list of technologies included in the design, like `Argo CD`, `AWS API Gateway`, or `Apache ShardingSphere`.
66
+
-**Type:** The category of the design, such as `deployment`, `observability`, `resiliency`, or `traffic-management`.
67
+
68
+
## Viewing Design Details
69
+
When you click on any design in the catalog, you are taken to its detail page. This page gives you a complete overview of the design's purpose, technical details, and how you can use it. The page is generally broken down into a few key areas:
70
+
71
+
#### Main Description
72
+
73
+
The central part of the page is dedicated to the **WHAT DOES THIS DESIGN DO?** section. This is the core documentation for the design, often broken down into specific use cases, components, and key notes to help you understand its architecture and how it works
74
+
75
+
#### Metadata
76
+
Class, Created By, and Dates: See the design's classification (e.g., Official), its original author, and when it was created and last updated.
77
+
Version: The design's version number. This increments automatically each time the design is updated.
78
+
Visibility: The status of the design. For all items found in the public catalog, this will be Published.
79
+
80
+
As you scroll down the page, you will find other useful sections:
81
+
82
+
Caveats and Considerations: Specific stipulations to consider and known behaviors to be aware of when using this design.
83
+
Similar Designs by Type: At the bottom, Meshery suggests other designs of the same type, helping you discover other relevant patterns.
84
+
85
+
### Actions
86
+
87
+
On the left side of the design detail page, you'll find a panel of buttons for actions.
88
+
89
+
#### Open in Playground
90
+
Clicking **Open in Playground** loads the design directly into [Kanvas](https://kanvas.new/).
91
+
92
+
#### Clone
93
+
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.
94
+
When you clone a design:
95
+
- The new copy will appear in your **My Designs** tab.
96
+
- Its name will be appended with `(Copy)` to distinguish it from the original.
97
+
- The visibility of the cloned design is set to **Private** by default, so only you can see it until you decide to publish it.
98
+
99
+
#### Download
100
+
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.
101
+
> For more advanced use cases, Meshery also supports exporting designs into other formats. To learn more, see the guide on [Exporting Designs](https://docs.layer5.io/kanvas/designer/export-designs/).
102
+
103
+
#### Edit
104
+
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.
105
+
You can modify the following fields:
106
+
-**Type:** Change the design's category.
107
+
-**Technology:** Add or remove associated technology tags.
108
+
-**Description:** Update the main purpose and intended uses of the design.
109
+
-**Caveats and Considerations:** Revise any special stipulations or known behaviors.
110
+
111
+
alert:
112
+
Some properties of a published design are immutable and cannot be changed through the edit screen:
113
+
**Name:** The original name of the published design cannot be modified.
114
+
**Visibility:** You cannot change a published design's visibility directly. To remove it from public view, you must **Unpublish** the item instead.
115
+
116
+
#### Unpublish
117
+
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.
Editing/Unpublish catalog items requires specific user roles and permissions. learn more: [Default Permissions documentation](https://docs.layer5.io/cloud/reference/default-permissions/).
0 commit comments