Skip to content

Commit 273d243

Browse files
committed
add catalog docs
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
1 parent a8f6f72 commit 273d243

1 file changed

Lines changed: 17 additions & 17 deletions

File tree

content/en/cloud/catalog/exploring-the-catalog.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Exploring the Catalog
2+
title: Exploring Meshery Catalog
33
weight: 3
44
description: "Discover how to browse, find, and interact with designs in the Catalog."
55
categories: [Catalog]
@@ -50,7 +50,7 @@ To customize the information displayed in this view, click the **View Columns ic
5050

5151
## Filtering and Sorting Catalog Items
5252

53-
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.
53+
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.
5454

5555
### Sort By
5656
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.
@@ -78,14 +78,14 @@ When you click on any design, you'll see its detail page. This page provides a c
7878

7979
### Metadata
8080

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

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

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

9090
## Available Actions
9191

@@ -98,9 +98,9 @@ Clicking **Open in Playground** loads the design directly into [Kanvas](https://
9898
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.
9999

100100
When you clone a design:
101-
- The new copy will appear in your **My Designs** tab
102-
- Its name will be appended with `(Copy)` to distinguish it from the original
103-
- The visibility of the cloned design is set to **Private** by default, so only you can see it until you decide to publish it
101+
- The new copy will appear in your **My Designs** tab.
102+
- Its name will be appended with `(Copy)` to distinguish it from the original.
103+
- The visibility of the cloned design is set to **Private** by default, so only you can see it until you decide to publish it.
104104

105105
### Download
106106

@@ -115,21 +115,21 @@ After you've published a design, you might need to update its metadata or descri
115115
![Design edit modal](/cloud/catalog/images/design-edit.png)
116116

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

123123
{{< alert type="warning" title="Immutable Properties" >}}
124124
Some properties of a published design are immutable and cannot be changed:
125-
- **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** it instead
125+
- **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** it instead.
127127
{{< /alert >}}
128128

129129
### Unpublish
130130

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

133133
{{< alert type="info" title="Permissions Required" >}}
134-
Editing/Unpublish catalog items requires specific user roles and permissions. Learn more: [Default Permissions documentation](/cloud/reference/default-permissions/).
134+
Editing/Unpublish published designs requires specific user roles and permissions. Learn more: [Default Permissions documentation](/cloud/reference/default-permissions/).
135135
{{< /alert >}}

0 commit comments

Comments
 (0)