Update publishing docs: add new images and update starting pattern guide #456
Conversation
Signed-off-by: Zihan Kuang <[email protected]>
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
https://deploy-preview-454--bejewelled-pegasus-b0ce81.netlify.app/kanvas/designer/export-designs/ - has the latest screenshot. 👍 |
|
@sangramrath had questions on this topic in the past, like "Can a design be edited after it has been published?" |
Is this where we should expect to see the new Publishing to Catalog doc? https://deploy-preview-454--bejewelled-pegasus-b0ce81.netlify.app/kanvas/tutorials/publishing-to-catalog/ |
There was a problem hiding this comment.
Will you consider relocating this page. Publishing of a design that a user has created is not considered a starter task. There is a placeholder under "tutorials" on this topic, but that is not the best location considering the content of this doc.
When we have an outline in a collaborative document, we can refine structure.
There was a problem hiding this comment.
Good. In the future, let's avoid nondescript examples like "publish test", but instead give the user concrete examples with populate fields, so that the concept is less abstract and more easily digested.
|
|
||
|  | ||
|
|
||
| #### State Transitions Overview |
There was a problem hiding this comment.
"State Transition" is good phrasing for contributors, but not so much for users.
"Phases of Publishing Process" or something similar might help user comprehension.
| - Withdrawn designs require re-submission as new entries. | ||
| - Published designs are immutable. | ||
|
|
||
| ### 3. Permission Controls |
There was a problem hiding this comment.
| ### 3. Permission Controls | |
| ### 3. Publishing Permissions |
|
|
||
| ### 3. Permission Controls | ||
|
|
||
| | **Operation** | **Creator** | **Organization Admin** | **Provider Admin** | **Regular User** | **Guest** | |
There was a problem hiding this comment.
| | **Operation** | **Creator** | **Organization Admin** | **Provider Admin** | **Regular User** | **Guest** | | |
| | **Operation** | **Owner** | **Organization Admin** | **Provider Admin** | **Regular User** | **Guest** | |
Change the column order to go from least privileged to most privileged. Use only roles that are published in https://docs.layer5.io/cloud/security/roles/. Potentially, include a tip that points to these roles and the default permissions reference - https://docs.layer5.io/cloud/reference/default-permissions/
| | **Operation** | **Creator** | **Organization Admin** | **Provider Admin** | **Regular User** | **Guest** | | ||
| |---------------------|--------------------|------------------------|--------------------|------------------|-------------------------| | ||
| | Edit Pending Design | ✔ | ✔ | ✔ | ✔ | ✔ | | ||
| | Unpublish | ✘ | ✔ | ✔ | ✘ | ✘ | |
There was a problem hiding this comment.
Please confirm that each of these operations corresponds to a permission key (sourced from the Meshery Cloud API Endpoints spreadsheet)
| |---------------------|--------------------|------------------------|--------------------|------------------|-------------------------| | ||
| | Edit Pending Design | ✔ | ✔ | ✔ | ✔ | ✔ | | ||
| | Unpublish | ✘ | ✔ | ✔ | ✘ | ✘ | | ||
|
|
There was a problem hiding this comment.
Are we missing "Submit for Review" as an operation?
|
|
||
| **Key Notes:** | ||
| - Provider Admins have root-level visibility and can see private designs from all organizations. | ||
| - Catalog approval queues are org-specific—only members of an organization can see its pending approvals, unless the user is a Provider Admin. |
There was a problem hiding this comment.
Org Admins are able to review (approve/deny requests) for designs submitted for review within their organization, right? Cloud fully supports Organization-specific catalog publishing queues, right?
There was a problem hiding this comment.
@fitzergerald @zihanKuang I checked https://deploy-preview-454--bejewelled-pegasus-b0ce81.netlify.app/kanvas/getting-started/starting-pattern/ but I couldn't find the updates images there.
Also are we addressing the following question "Can a design be edited after it has been published" in this article?
|
@zihanKuang adding it as an agenda item to the meeting minutes. |
This PR addresses updates to the Publishing and Managing Designs documentation
Changes Introduced
Updated Documentation:
Added New Images:
Publishing-flow.svg(State lifecycle visualization)approval-queue.png(Approval workflow UI)designs-select-design.png(Design selection UI)designs-select-sidebar.png(Sidebar selection UI)publish-form.png(Publishing form UI)Removed Old Images:
2024-04-14_12-40.png2024-04-14_12-44.png(These two images were removed because their content has been replaced with new, updated images. Other cloned images are still being used in different parts of the documentation, so only these two were deleted.)
Code Changes:
layouts/_default/content.htmlto explicitly define dark theme by addingdata-bs-theme="dark"to.td-contentdiv.content/en/kanvas/getting-started/starting-pattern.md.Notes for Reviewers
The documentation now aligns better with the Meshery UI updates.
Please review the state transitions and permissions section for accuracy.
Ensure the new images are correctly linked and displayed in the rendered documentation.
Yes, I signed my commits.