Skip to content

Commit 5299b5c

Browse files
committed
docs: update publishing designs guide and assets
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
1 parent 35d2e4a commit 5299b5c

12 files changed

Lines changed: 131 additions & 0 deletions

File tree

File renamed without changes.
File renamed without changes.

content/en/kanvas/designer/publishing-designs/images/Publishing-flow.svg

Lines changed: 1 addition & 0 deletions
Loading
44.8 KB
Loading
11.6 KB
Loading
67.1 KB
Loading
93.1 KB
Loading
Lines changed: 130 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
---
2+
title: Publishing Designs
3+
description: Learn to publish, manage, and work with designs in Meshery with clear state transitions, role-based permissions, and common workflow FAQs.
4+
weight: 3
5+
categories: [Designer]
6+
tags: [designs, publishing]
7+
aliases:
8+
- /meshmap/designer/publish-designs
9+
---
10+
11+
Publishing a design makes it visible to all Meshery Cloud users and anonymous visitors. This guide explains the publishing workflow, state management, permissions, and operational constraints.
12+
13+
## Publishing Workflow
14+
15+
### Step 1: Access Extensions UI
16+
Navigate to Meshery [Kanvas Designer](https://playground.meshery.io/extension/meshmap) from the main dashboard.
17+
18+
### Step 2: Select Design in Sidebar
19+
Publish designs through two methods. Click the **info ("i")** button for details.
20+
21+
- **Option 1:** View designs in the sidebar
22+
![Sidebar Design List](/kanvas/designer/publishing-designs/images/designs-select-sidebar.png)
23+
24+
- **Option 2:** Go to Configuration → Designs
25+
![Design Details](/kanvas/designer/publishing-designs/images/designs-select-design.png)
26+
27+
### Step 3: Submit Design Metadata
28+
Fill out the publication form:
29+
30+
- **Type:** Select design category
31+
- **Technology:** Specify related technology
32+
- **Description:** Explain purpose and usage
33+
- **Caveats:** Add important considerations
34+
35+
![Publish Modal](/kanvas/designer/publishing-designs/images/publish-form.png)
36+
37+
### Step 4: Review Process
38+
Approval workflow based on user role:
39+
- **Admin submissions:** Published immediately
40+
- **User submissions:** Enter "Pending Review"
41+
42+
Submissions in the “Pending Review” state will remain unpublished until they are manually reviewed and either approved or rejected by an Organization Admin or Provider Admin. This review process may take some time depending on the availability of reviewers. Regardless of approval or rejection, submitters will receive an email notification with the decision.
43+
44+
![Approval Queue](/kanvas/designer/publishing-designs/images/approval-queue.png)
45+
46+
### Step 5: Post-Approval Status
47+
Once the review process is complete, you will receive an email notification informing you of the decision.
48+
49+
- If your design is approved:
50+
- It will no longer appear in "My Designs."
51+
- Instead, it will be listed in the **[Catalog](https://cloud.layer5.io/catalog)** as a publicly available entry.
52+
- This ensures that published designs remain accessible to all users while keeping personal design spaces uncluttered.
53+
54+
- If your design is rejected:
55+
- You will receive an email notification with a rejection reason.
56+
- Rejected designs **cannot be resubmitted** directly.
57+
- If you want to revise and submit it again, you must clone the design, make changes, and submit it as a new entry.
58+
59+
## Cloning a Design
60+
To modify published designs:
61+
62+
1. Select design from [Catalog](https://cloud.layer5.io/catalog)
63+
2. Click **Clone** to create editable copy
64+
3. Make changes and submit as new version
65+
66+
## State Management
67+
68+
### 1. Design State Lifecycle
69+
A design transitions through multiple states from creation to publication. The diagram below visually represents this process.
70+
71+
![Publishing Flow](/kanvas/designer/publishing-designs/images/Publishing-flow.svg)
72+
73+
#### Phases of Publishing Process
74+
- **Pre-Publish:** Users freely create and edit designs.
75+
- **Pending Review:** Submitted designs undergo an approval process.
76+
- **Published:** Approved designs are locked and listed publicly.
77+
- **Withdrawn:** Unpublished designs return to private storage.
78+
79+
### 2. Design State Characteristics
80+
81+
| **State Stage** | **Visibility** | **Operability** | **Key Restrictions** |
82+
|--------------------|----------------------------------|------------------------------------------------|--------------------------------------------------------------------|
83+
| **Pre-Publish** | Sidebar Design List & Configuration → Designs | Free edit/delete/rename (editable by anyone) | No restrictions |
84+
| **Pending Review** | Sidebar Design List & Configuration → Designs | Editable by all users (including guests) | Deleting during this stage creates dead entries in the approval list |
85+
| **Published** | Category List (hidden in sidebar) | View-only copies (auto-appended "_copy") | Original design permanently locked (edit in category only updates metadata) |
86+
| **Withdrawn** | Returns to sidebar as private | Free edit/delete/rename | Original cannot be republished; must create a new canvas with identical content |
87+
88+
**Critical Rules:**
89+
- Withdrawn designs require re-submission as new entries.
90+
- Published designs are immutable.
91+
92+
### 3. Publishing Permissions
93+
94+
| **Operation** | **Guest** | **Regular User** | **Owner** | **Organization Admin** | **Provider Admin** |
95+
|---------------------|-----------|------------------|-----------|------------------------|--------------------|
96+
| Edit Pending Design ||||||
97+
| Submit for Review ||||||
98+
| Unpublish ||||||
99+
100+
For more about roles and permissions, refer to [Role Descriptions](https://docs.layer5.io/cloud/security/roles/) and [Default Permissions](https://docs.layer5.io/cloud/reference/default-permissions/).
101+
102+
**Key Notes:**
103+
- Provider Admins have root-level visibility and can see private designs from all organizations.
104+
- Catalog approval queues are org-specific—only members of an organization can see its pending approvals, unless the user is a Provider Admin.
105+
- The "Unpublish" button is visible to all users except Guests. However, only Admins can successfully execute the action. For all other users, clicking the button will result in an error message indicating insufficient permissions.
106+
107+
## FAQ
108+
109+
### 1. When my design is in "Pending Review," can I still edit it? Will the changes take effect?
110+
Yes, you can edit your design while it is in the "Pending Review" state, and any modifications will be automatically reflected in the submitted design. No need to resubmit the request.
111+
112+
### 2. After my design is approved and published, can I modify it? Will the category be updated?
113+
No, once a design is **published**, it becomes **immutable**. You cannot directly edit or modify the contents. The category and metadata remain locked to ensure version consistency. However, you can create a new version by cloning the design and making modifications.
114+
115+
### 3. After my design is published, can I modify the category field?
116+
No, the category field **cannot be changed** after the design is published. If a category update is required, you must clone the design, update the category, and submit it as a new entry.
117+
118+
### 4. If my design is denied (rejected), can I submit it again?
119+
No, once a design is denied, it **cannot be resubmitted**. However, you can clone the design, make adjustments, and submit it as a new entry for review.
120+
121+
### 5. Can I unpublish a design after it has been published?
122+
Only Admins and Provider Admins have the ability to unpublish a design, Regular users, creators, and guests cannot unpublish a design. If you need to remove a published design, contact an Admin or Provider Admin to request unpublishing.
123+
124+
### 6. What is the difference between Public, Private, and Published?
125+
126+
| **State** | **Visibility** | **Editability** | **Notes** |
127+
|-------------|---------------|----------------|-----------|
128+
| **Public** | Visible to all Meshery Cloud users | Fully editable | Available for all users to access |
129+
| **Private** | Only visible to the owner and organization members | Fully editable | Used for drafts and internal work |
130+
| **Published** | Approved and locked for public access | Cannot be modified | Ensures design consistency and prevents unauthorized edits |
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)