Skip to content

Commit 5aaa7f9

Browse files
committed
add caalog docs
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
1 parent 508960f commit 5aaa7f9

3 files changed

Lines changed: 21 additions & 17 deletions

File tree

content/en/cloud/catalog/guide.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,19 @@ tags: [Designer]
88

99
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.
1010

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

1313
## Viewing Catalog Items
1414

1515
The main catalog page displays all available designs in an organized, searchable format.
1616

1717
### Top Performers
18-
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/).
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/).
1919
- To see the complete rankings, click the **Open Leaderboard** button.
2020
- You can toggle the visibility of this section using the **Hide Performers** / **Show Performers** button.
2121

22-
{{< alert type="info" title="Learn More" >}}
23-
To learn more about Leaderboard, see the [Leaderboard documentation](https://docs.layer5.io/cloud/catalog/leaderboard/).
22+
{{< alert type="info" title="Learn More About Leaderboard" >}}
23+
To learn more about Leaderboard, see the [Leaderboard documentation](/cloud/catalog/leaderboard/).
2424
{{< /alert >}}
2525

2626
### Grid View
@@ -32,19 +32,19 @@ The grid view offers a visual, card-based layout that's ideal for browsing desig
3232
- **Metrics:** A row of icons at the bottom displays key usage statistics (Opens, Downloads, Deploys, Clones, Shares)
3333
- **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
3434

35-
![](/images/card-view.png)
35+
![Catalog card view with metrics](/cloud/catalog/images/card-view.png)
3636

37-
{{< alert type="info" title="Learn More" >}}
38-
To better understand what these Metrics represent, you can learn more about [design metrics](https://docs.layer5.io/cloud/catalog/metrics/).
37+
{{< alert type="info" title="Understanding Design Metrics" >}}
38+
To better understand what these Metrics represent, you can learn more about [design metrics](/cloud/catalog/metrics/).
3939
{{< /alert >}}
4040

4141
### Table View
4242

4343
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.
4444

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

47-
{{< alert type="info" title="Choose Your View" >}}
47+
{{< alert type="info" title="Choose Your Preferred View" >}}
4848
Both the grid and table views provide the same set of management capabilities, so you can pick the layout that best suits your task.
4949
{{< /alert >}}
5050

@@ -66,7 +66,7 @@ The `Class` filter helps you find content based on its level of support and veri
6666
- **Community:** Content produced and shared by Meshery users. This includes a wide range of content with varying levels of support and reliability.
6767

6868
#### Technology and Type
69-
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.
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.
7070
- **Technology:** A list of technologies included in the design, like `Argo CD`, `AWS API Gateway`, or `Apache ShardingSphere`.
7171
- **Type:** The category of the design, such as `deployment`, `observability`, `resiliency`, or `traffic-management`.
7272

@@ -106,7 +106,7 @@ When you clone a design:
106106

107107
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.
108108

109-
> 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/).
109+
> 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/).
110110
111111
### Edit
112112

@@ -118,6 +118,8 @@ You can modify the following fields:
118118
- **Description:** Update the main purpose and intended uses of the design
119119
- **Caveats and Considerations:** Revise any special stipulations or known behaviors
120120

121+
![Design edit modal](/cloud/catalog/images/design-edit.png)
122+
121123
{{< alert type="warning" title="Immutable Properties" >}}
122124
Some properties of a published design are immutable and cannot be changed through the edit screen:
123125
- **Name:** The original name of the published design cannot be modified
@@ -129,5 +131,5 @@ Some properties of a published design are immutable and cannot be changed throug
129131
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.
130132

131133
{{< alert type="info" title="Permissions Required" >}}
132-
Editing/Unpublish catalog items requires specific user roles and permissions. Learn more: [Default Permissions documentation](https://docs.layer5.io/cloud/reference/default-permissions/).
134+
Editing/Unpublish catalog items requires specific user roles and permissions. Learn more: [Default Permissions documentation](/cloud/reference/default-permissions/).
133135
{{< /alert >}}

content/en/cloud/catalog/leaderboard.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ tags: [Designer]
99

1010
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.
1111

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

14-
{{< alert type=info title="" >}}
14+
{{< alert type="info" title="Understanding Metrics" >}}
1515
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/)
1616
{{< /alert >}}
1717

@@ -28,7 +28,9 @@ You can reach the Leaderboard page in two ways:
2828

2929
The Leaderboard page offers several ways to explore and interact with the data:
3030

31-
- **Search for Designs:**Click the **Search** icon to quickly find specific designs by name.
31+
- **Search for Designs:** Click the **Search** icon to quickly find specific designs by name.
3232
- **Sort by Different Metrics:** Click on column headers like `Opens`, `Clones`, or `Downloads` to reorder the list based on your preferred metric.
3333
- **Customize Your View:** Click the **View Columns** icon to show or hide specific metric columns.
3434
- **Take Actions:** Click the **Actions** icon to download, share, or perform other actions.
35+
36+
![Leaderboard action menu](/cloud/catalog/images/leaderboard-action.png)

content/en/cloud/catalog/metrics.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ tags: [Designer]
99

1010
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.
1111

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

14-
{{< alert title="Note" >}}
14+
{{< alert type="info" title="Design Capabilities" >}}
1515

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

0 commit comments

Comments
 (0)