Skip to content

Commit a17cfea

Browse files
authored
Merge pull request #510 from zihanKuang/add-workspace-delete
Improve Workspace Docs: Add Deletion Info, Fix Typos, and Update Alerts
2 parents 943f452 + c31470b commit a17cfea

File tree

1 file changed

+35
-23
lines changed

1 file changed

+35
-23
lines changed

content/en/cloud/spaces/workspaces.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -6,32 +6,42 @@ weight: 6
66
categories: [Spaces]
77
---
88

9-
Meshery Workspaces serve as a virtual space for your team-based work. Create a Workspace to organize your work and to serve as the central point of collaboration for you and your teams and a central point of access control to Environments and their resources.
109

11-
You may create Workspaces to organize project-based work or to create domains of responsibility for your teams or segregate Designs and Environments and track team activity.
10+
Meshery Workspaces provide a virtual space for you and your teams to collaborate, organize project-based work, manage access to environments and resources, and track team activities.
1211

13-
## Summary
14-
15-
Workspaces facilitate collaboration between you and your teams, allow you to control access to resources, and track activity and report on related events.
12+
You can create Workspaces to group related Designs and Environments, define domains of responsibility for your teams, and streamline resource management.
1613

1714
## Key Features
1815

19-
- **Resource Sharing** Workspaces allow for seamless resource sharing among team members, fostering collaboration.
20-
- **Logical Grouping** Within Workspaces, you can group related components such as environments and infrastructure designs.
21-
- **Flexibility**: Workspaces support various resources like Kubernetes, Prometheus, Jaeger, Nginx, and more.
22-
- **Simplified Management** Managing and deploying resources is made easy within Workspaces.
23-
- **Access Control** Workspaces allow you to control access to resources by granting permissions to users and teams.
16+
- **Resource Sharing:** Workspaces allow for seamless resource sharing among team members, fostering collaboration.
17+
- **Logical Grouping:** Within Workspaces, you can group related components such as environments and infrastructure designs.
18+
- **Flexibility:** Workspaces support various resources like Kubernetes, Prometheus, Jaeger, Nginx, and more.
19+
- **Simplified Management:** Managing and deploying resources is made easy within Workspaces.
20+
- **Access Control:** Workspaces allow you to control access to resources by granting permissions to users and teams.
2421

2522
### Workspace Relationships and Restrictions
2623

2724
- Access to Workspaces may be granted to one or more teams.
2825
- As a point of collaboration to facilitate work, Workspaces may have zero or more Environments associated.
2926
- A Workspace is closely associated with Teams in Meshery. Teams are groups of users with varying permissions, and they are at the center of resource access and management within a Workspace.
30-
- One ore more teams can be assigned to a workspace.
31-
- Same team can be assigned to multiple workspaces.
32-
- A team can be assigned to a workspace only if the team is not already assigned to another workspace.
27+
- One or more teams can be assigned access to a workspace.
28+
29+
After creating a Workspace, one of your next steps is to assign team access, create or transfer designs into the Workspace, and allocate resources that to Workspace by associating it with one or more Environments, therein making the Environment's connections available to users of the Workspace.
30+
31+
Like a shared drive (or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs.
32+
33+
### Workspace Deletion Behavior
3334

34-
After creating a Workspace, of your next steps is to resource that Workspace. Like a shared drive (or or shared collection of files). Workspaces are your Google Drive, while Meshery Designs are your Google Docs.
35+
When a Workspace is deleted:
36+
37+
- Deletion is **permanent and irreversible**. Proceed with caution.
38+
- Before deletion, users have the option to transfer associated Designs and Views to another Workspace.
39+
- If no transfer is made, all associated Designs and Views will be permanently deleted along with the Workspace[^1].
40+
- Any associated Teams or Environments will be detached from the Workspace but will remain available for reassignment.
41+
42+
{{< alert type="info" title="What Happens When a Workspace is Deleted?" >}}
43+
Deleting a Workspace will permanently remove the Workspace itself and its associated Designs and Views, unless they are transferred beforehand. Teams and Environments will remain intact but will no longer be associated with the deleted Workspace.
44+
{{< /alert >}}
3545

3646
## Key Workspace Components
3747

@@ -41,28 +51,28 @@ After creating a Workspace, of your next steps is to resource that Workspace. Li
4151
- One or more environments can be assigned to a workspace.
4252
- Same environment can be assigned to multiple workspaces.
4353

44-
{{< alert type="info" >}}
54+
{{< alert type="info" title="Assigning Environments to Workspaces" >}}
4555
Assign any number of Environments to one or more Workspaces. See [Environments](https://docs.meshery.io/concepts/environments) section for more information.
4656
{{< /alert >}}
4757

4858
### Designs
4959

5060
- Infrastructure Designs are essential for creating reusable deployment templates. Users belonging to teams with access to a workspace can utilize these designs to deploy resources in the Kubernetes clusters associated with that workspace.
51-
- Like a shared drive (or or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs.
52-
- One ore more designs can be assigned to a workspace.
53-
- Same design can be assigned to multiple workspaces.
61+
- Like a shared drive (or shared collection of files), Workspaces are your Google Drive, while Meshery Designs are your Google Docs.
62+
- One or more designs can be assigned to a workspace.
63+
- The Same design can be assigned to multiple workspaces.
5464

55-
{{< alert type="info" >}}
65+
{{< alert type="info" title="Design Ownership in Workspaces" >}}
5666
Designs belong to only one Workspace at any given time. See [Meshery Designs](https://docs.meshery.io/concepts/designs) section for more information.
5767
{{< /alert >}}
5868

5969
### Teams
6070
- A Workspace is closely associated with Teams in Meshery. Teams are groups of users with varying permissions, and they are at the center of resource access and management within a Workspace.
61-
- One ore more teams can be assigned to a workspace.
71+
- One or more teams can be assigned to a workspace.
6272
- Same team can be assigned to multiple workspaces.
6373

64-
{{< alert type="info" >}}
65-
Teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections, See [Teams](/cloud/identity/teams).
74+
{{< alert type="info" title="Team Access Control in Workspaces" >}}
75+
Teams offer control access to workspaces and to workspace resources such as environments and managed and unmanaged connections. See [Teams](/cloud/identity/teams).
6676
{{< /alert >}}
6777

6878
### Connections
@@ -71,7 +81,7 @@ Teams offer control access to workspaces and to workspace resources such as envi
7181
- Connections can be assigned to one or more environments.
7282
- Same connection can be assigned to multiple environments.
7383

74-
{{< alert type="info" >}}
84+
{{< alert type="info" title="Learn More About Connections" >}}
7585
See [Connections](https://docs.meshery.io/concepts/logical/connections) section for more information.
7686
{{< /alert >}}
7787

@@ -84,3 +94,5 @@ To make the most of Meshery Workspaces, here are some best practices:
8494
- Regularly review and update your Workspace's resources and configurations.
8595

8696
Meshery Workspaces enhance collaboration within your teams, providing a structured environment for sharing and managing resources. By following best practices and understanding the core components of Workspaces, you can maximize the benefits of this feature in Meshery.
97+
98+
[^1]: This functionality is not fully implemented yet. Users might occasionally observe that designs and views are preserved after Workspace deletion.

0 commit comments

Comments
 (0)