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/guide.md
+52-39Lines changed: 52 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,12 +7,13 @@ categories: [Catalog]
7
7
tags: [Designer]
8
8
---
9
9
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.
10
+
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.
11
11
12
12
13
13
14
14
## Viewing Catalog Items
15
-
The main catalog page is where you can see all available designs.
15
+
16
+
The main catalog page displays all available designs in an organized, searchable format.
16
17
17
18
### Top Performers
18
19
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/).
@@ -24,19 +25,23 @@ To learn more about Leaderboard, see the [Leaderboard documentation](https://doc
24
25
{{< /alert >}}
25
26
26
27
### 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
28
33
-
To better understand what these Metrics represent, you can learn more about [design metrics](https://docs.layer5.io/cloud/catalog/metrics/).
29
+
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:
34
30
35
-
[](/images/card-view.png)
31
+
-**Class:** The banner in the top-left corner shows the design's classification (e.g., Official)
32
+
-**Type:** The tag in the top-right corner indicates the design's category (e.g., Deployment)
33
+
-**Metrics:** A row of icons at the bottom displays key usage statistics (Opens, Downloads, Deploys, Clones, Shares)
34
+
-**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
36
35
36
+
37
+
38
+
{{< alert type="info" title="Learn More" >}}
39
+
To better understand what these Metrics represent, you can learn more about [design metrics](https://docs.layer5.io/cloud/catalog/metrics/).
40
+
{{< /alert >}}
37
41
38
42
### 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.
43
+
44
+
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.
40
45
41
46
42
47
@@ -54,7 +59,8 @@ You can order all items in the catalog based on different criteria, such as alph
54
59
#### Owner
55
60
Filter designs based on their owner, whether it's your entire Organization, specific Teams, or an individual Author.
56
61
57
-
#### Class
62
+
### Class
63
+
58
64
The `Class` filter helps you find content based on its level of support and verification:
59
65
-**Official:** Content produced and fully supported by Meshery maintainers. This represents the highest level of support and is considered the most reliable.
60
66
-**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,56 +72,63 @@ These filters correspond to the metadata auther provide when they publish design
66
72
-**Type:** The category of the design, such as `deployment`, `observability`, `resiliency`, or `traffic-management`.
67
73
68
74
## 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
75
71
-
#### Main Description
76
+
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.
72
77
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
78
+
### Metadata
74
79
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.
80
+
-**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
+
-**Version:** The design's version number. This increments automatically each time the design is updated
82
+
-**Visibility:** The status of the design. For all items found in the public catalog, this will be Published
79
83
80
84
As you scroll down the page, you will find other useful sections:
81
85
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.
86
+
-**Caveats and Considerations:** Specific stipulations to consider and known behaviors to be aware of when using this design
87
+
-**Similar Designs by Type:** At the bottom, other designs of the same type, helping you discover other relevant patterns
84
88
85
-
###Actions
89
+
## Actions
86
90
87
-
On the left side of the design detail page, you'll find a panel of buttons for actions.
91
+
You can perform various actions on each design in the catalog.
92
+
93
+
### Open in Playground
88
94
89
-
#### Open in Playground
90
95
Clicking **Open in Playground** loads the design directly into [Kanvas](https://kanvas.new/).
91
96
92
-
#### Clone
97
+
### Clone
98
+
93
99
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.
100
+
94
101
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.
102
+
- The new copy will appear in your **My Designs** tab
103
+
- Its name will be appended with `(Copy)` to distinguish it from the original
104
+
- The visibility of the cloned design is set to **Private** by default, so only you can see it until you decide to publish it
105
+
106
+
### Download
98
107
99
-
#### Download
100
108
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
+
101
110
> 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
111
103
-
#### Edit
112
+
### Edit
113
+
104
114
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
+
105
116
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.
117
+
-**Type:** Change the design's category
118
+
-**Technology:** Add or remove associated technology tags
119
+
-**Description:** Update the main purpose and intended uses of the design
120
+
-**Caveats and Considerations:** Revise any special stipulations or known behaviors
Some properties of a published design are immutable and cannot be changed through the edit screen:
124
+
-**Name:** The original name of the published design cannot be modified
125
+
-**Visibility:** You cannot change a published design's visibility directly. To remove it from public view, you must **Unpublish** the item instead
126
+
{{< /alert >}}
110
127
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.
128
+
### Unpublish
115
129
116
-
#### Unpublish
117
130
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/).
133
+
Editing/Unpublish catalog items requires specific user roles and permissions. Learn more: [Default Permissions documentation](https://docs.layer5.io/cloud/reference/default-permissions/).
Copy file name to clipboardExpand all lines: content/en/cloud/catalog/leaderboard.md
+12-14Lines changed: 12 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,28 +9,26 @@ tags: [Designer]
9
9
10
10
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.
11
11
12
+
12
13
13
-
{{< alert title="Note" >}}
14
-
14
+
{{< alert type=info title="" >}}
15
15
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/)
16
-
17
16
{{< /alert >}}
18
17
19
-
### leader board
20
-
会在catalog的主页显示内容，top performers
21
-
然后会显示内容包括最热门的五个
22
-
如果想查看更多，点击Leaderboard按钮查看全面的
23
-
24
18
### How to Access the Leaderboard
25
19
26
-
1. Open the design catalog on the _Layer5 Cloud_ catalog page at [Layer5 Cloud Catalog](https://cloud.layer5.io/catalog).
20
+
You can reach the Leaderboard page in two ways:
27
21
28
-
2. By clicking on the Leaderboard icon button, you will be redirected to the [Leaderboard](https://cloud.layer5.io/catalog/leaderboard) page.
0 commit comments