doc: Add "Managing Workspaces" Guide #614
Conversation
✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
|
||
| The [Workspaces page](https://cloud.layer5.io/spaces/workspaces) is where you can see all of the workspaces within the currently selected organization. | ||
|
|
||
| To suit different workflows, you can switch between two distinct layouts: a visual grid view and a detailed table view. |
There was a problem hiding this comment.
I wonder if this might be presented as a tip-style alert. Maybe so or maybe it would be unnecessarily distracting. Hmm.
There was a problem hiding this comment.
Also, I wonder if the "grid view" and "table view" words should be hyperlinked to their respective sections.
| #### Workspace Deletion Behavior | ||
| When a Workspace is deleted: | ||
|
|
||
| - Deletion is **permanent and irreversible**. Proceed with caution. |
There was a problem hiding this comment.
It is implied, but not directly stated that all designs and views within the workspace will be deleted along with the workspace itself. It might be good to explicitly state this upfront.
|
|
||
|  | ||
|
|
||
| You can open the team management modal from either the grid or table view. |
There was a problem hiding this comment.
I wonder if we should be using the term "modal" in our user-facing docs.
| 3. Click **Save** to apply your changes. | ||
|
|
||
| {{< alert type="info" title="Team and Workspace Relationships" >}} | ||
| You can assign multiple teams to a single workspace, and a single team can also be a member of multiple workspaces. This provides flexible access control across your projects. For more restrictions, see [Workspaces documentation](https://docs.layer5.io/cloud/spaces/workspaces/). |
| 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. |
There was a problem hiding this comment.
Does this page have a link to the "Managing Workspaces" page? Should it or are the Previous and Next page buttons sufficient in this case?
|
Topics and questions to address either in these two pages or other pages:
@zihanKuang @vishalvivekm, please open issue(s) if these questions / topics are to be covered elsewhere. |
|
@Nitish-bot, you might like to undertake #8 above. By "undertake", I mean document your empirical findings as you explore this feature. |
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
|
Hi @leecalcote, I've updated the PR based on your suggestions:
Additionally, I've created issue #616 for the questions. |
|
@zihanKuang are you merging? |
Signed-off-by: Zihan Kuang <zihan_kuang@outlook.com>
|
@leecalcote, I've implemented the 'danger' styling to mark elements in red. |
|
Excellent. Yes, again, please merge. |
Notes for Reviewers
This PR fixes #610
managing-workspaces.mdguide. It documents management operations for Workspaces, including creation, editing, deletion, and resource assignment.workspaces.mdinto this new guide.