-
Notifications
You must be signed in to change notification settings - Fork 83
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add docs for sharing design and managing access permissions #231
Add docs for sharing design and managing access permissions #231
Conversation
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
I'll complete this in an hour |
Signed-off-by: Yash Sharma <[email protected]>
Signed-off-by: Yash Sharma <[email protected]>
This PR covers user facing docs on how to share design and set access type, I'll be explaining the concept of resource and below questions in separate page in cloud doc Flow 2: As a Team Admin, I would like to control (grant, revoke) Workspace access to another Team, so that I can conveniently control access by groups of users. |
Signed-off-by: Yash Sharma <[email protected]>
Signed-off-by: Yash sharma <[email protected]>
|
||
## Overview | ||
|
||
In MeshMap, you can share your designs or design that you have permission to share with other members of your organization and teams and can control over access permissions. This page describes access types for designs and how to effectively use them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the first sentence is too long and as a result ambiguous. Maybe we should break it up into two short sentences.
|
||
## Visibility | ||
|
||
Designs and Views have visibility status which defines who can access your designs. These options provide different levels of exposure for your designs: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Designs and Views have visibility status which defines who can access your designs. These options provide different levels of exposure for your designs: | |
Designs and Views have a visibility status which defines who can access them. These options provide different levels of exposure for your designs: |
|
||
## Overview | ||
|
||
In MeshMap, you can share your designs or design that you have permission to share with other members of your organization and teams and can control over access permissions. This page describes access types for designs and how to effectively use them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In MeshMap, you can share your designs or design that you have permission to share with other members of your organization and teams and can control over access permissions. This page describes access types for designs and how to effectively use them. | |
In MeshMap, you can share your designs or designs that you have permission to share with other members of your organization and teams. You also have control over access permissions for these designs. This page describes access types for designs and how to effectively use them. |
|
||
Designs and Views have visibility status which defines who can access your designs. These options provide different levels of exposure for your designs: | ||
|
||
- **Private:** Designs or Views with visibility status private defines only you, the creator, and the user or team that have access based on granted access permission can view and edit the design. Other users cannot access it unless you explicitly share it with them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- **Private:** Designs or Views with visibility status private defines only you, the creator, and the user or team that have access based on granted access permission can view and edit the design. Other users cannot access it unless you explicitly share it with them. | |
- **Private:** Designs or Views set to **private** are accessible only to you, the creator, and to users or teams granted access permission. They can view and edit the design. Other users cannot access it unless you explicitly share it with them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @Yashsharma1911. This looks great. Well done. I left a few comments.
Signed-off-by: Archit Sharma <[email protected]>
Signed-off-by: Archit Sharma <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's merge
Notes for Reviewers
This PR fixes #
title: Sharing Designs
description: >
Share design with other users and use control access to manage design access permissions and visibility.
weight: 3
categories: [Designer]
tags: [designs, collaboration, review]
Overview
In MeshMap, you can share your designs or design that you have permission to share with other members of your organization and teams and can control over access permissions. This page describes control access permissions for designs and how to effectively use them.
{{< alert title="Note">}}
{{< /alert >}}
Visibility
Designs and Views have visibility status which defines who can access your designs. These options provide different levels of exposure for your designs:
Private: Designs or Views with visibility status private defines only you, the creator, and the user or team that have access based on granted access permission can view and edit the design. Other users cannot access it unless you explicitly share it with them.
Public: Making a design public allows anyone within your organization to view, comment on, and edit the design. This feature is useful for sharing best practices, reference architectures, or contributions within your organization. However, as the owner of the design, you can restrict permissions for individual users or teams by adding and customizing access permissions. We will discuss how you can do this in the next section.
Published: The published visibility setting is designed for sharing designs with a wider audience. Published designs become discoverable to other Meshery users and allows them to view, download and clone the design. Users can find published designs through Meshery Catalog and catalog tab within MeshMap.
Granting access for Individual Users
As a design owner, you have granular control over access permissions for your designs.
Following steps shows how you can grant access to individual users:
You can also change visibility status between public and private of design from here.
Access types and their Impact:
In share modal, you have different access types that you can assign to users or teams for your designs.
The Owner, Editor, and Viewer access types are hierarchical, meaning that the Owner access includes the edit access, and the Edit access includes the view access.
If there are explicit access type set for a user, that will take precedence and be considered active. Otherwise, the access type assigned to the team will be used if the user is part of team and team has access.
For example, if Sarah has been granted specific access type, that will be active. However, if no specific access permission are set for Sarah, but she's part of a team with access, then the access type of that team will apply to her.
Revoking, and Re-inviting Access:
You can manage access permissions at any time by revisiting the "Share" modal. This modal allows you to grant access to new users, revoke access or even update the access permissions of current users.
Share design via link
You can share your design via link, for that revisit the "Share" modal and click on "Copy Link" button. You will be allowed to share the link only if your design's visibility status is public, anyone who click the link or you share with can be able to access your design. It's important to understand that currently making design public allows users to view, comment and edit the design.
This can be useful when you want to share design with multiple users without explicitly giving the access.
Granting access for Teams (Upcoming feature)
In an upcoming feature, MeshMap will introduce the ability to grant access to entire teams, simplify the process of collaboration and sharing within your organization. This feature will offer a convenient way to manage permissions for groups of users who are working together on projects or tasks.
With this new capability, you'll be able to designate specific teams within your organization and grant them access to designs. Instead of individually assigning permissions to each member, you can simply assign permissions to the team as a whole, and manage access permission like view, comment and edit for team.
Understanding the Implications of adding a Design to a Workspace:
When you add design to a workspace, it signifies that all teams associated with that workspace will be allowed to access your designs even if it is private, however you can update the access type of team by revisiting the "Share" modal within MeshMap.
Learn more about auditing the access permission within workspace
{{< alert title="Note">}}
{{< /alert >}}
Signed commits