[Workspace] Add workspace design documentation #5282
Conversation
There was a problem hiding this comment.
Firstly, love the clear and objective outline of the workspace plugin and its features. One suggestion i have is to move this doc to the workspaces plugin folder. Usually docs that are specific to just one plugin are kept there since its the most obvious place someone will look to understand the plugin and its usage. This folder is usually reserved for features that span multiple plugins and more abstract docs that dont really make sense elsewhere.
docs/plugins/workspace.md
Outdated
| Workspace is a pivotal feature within OpenSearch-Dashboards, empowering users to craft distinct workspaces | ||
| by meticulously curating a selection of features and plugins tailored to specific use cases. This functionality | ||
| not only facilitates clients in the systematic organization of visual assets, including saved_objects such as | ||
| dashboards and visualizations, but also categorizes them logically within dedicated workspaces. This strategic | ||
| approach enhances overall efficiency and manageability, making it an indispensable asset for OpenSearch-Dashboards | ||
| users seeking precision and flexibility in their workflows. |
There was a problem hiding this comment.
Nit: While the overall doc is objective and informative, this section seems a little sensational. I'm assuming that this was copied over from the proposal. Can we make this section less sensational and objective too?
There was a problem hiding this comment.
Sounds good to me, updated accordingly.
docs/plugins/workspace.md
Outdated
| - **Permissions**: Initially, access to the Management Workspace is set to public during initialization, administrators have the | ||
| responsibility and privilege to restrict access and define permissions within the Management Workspace. | ||
|
|
||
| ## Appendix |
There was a problem hiding this comment.
Is there an issue/proposal for the overall Workspaces feature that we can link to over here? The two links below are useful but only talk about access control and not the overall feature.
There was a problem hiding this comment.
I added one link to the feature from product design's perspective, that may help to understand the feature from a high level.
Signed-off-by: Yulong Ruan <[email protected]>
ruanyl
force-pushed
the
workspace-feature-doc
branch
from
690c324 to
66c55c2
Compare
ruanyl
requested review from
ananzh,
kavilla,
AMoo-Miki,
joshuarrrr,
abbyhu2000,
zengyan-amazon,
zhongnansu,
manasvinibs,
ZilongX,
Flyingliuhub,
curq,
bandinib-amzn,
SuZhou-Joe,
BionIT,
xinruiba and
zhyuanqi
as code owners
ruanyl
requested review from
mengweieric,
LDrago27,
virajsanghvi,
sejli and
joshuali925
as code owners
ruanyl
changed the title
ruanyl
changed the title
❌ Invalid Changelog HeadingThe '## Changelog' heading in your PR description is either missing or malformed. Please make sure that your PR description includes a '## Changelog' heading with proper spelling, capitalization, spacing, and Markdown syntax. |
1 similar comment
❌ Invalid Changelog HeadingThe '## Changelog' heading in your PR description is either missing or malformed. Please make sure that your PR description includes a '## Changelog' heading with proper spelling, capitalization, spacing, and Markdown syntax. |
❌ Invalid Changelog HeadingThe '## Changelog' heading in your PR description is either missing or malformed. Please make sure that your PR description includes a '## Changelog' heading with proper spelling, capitalization, spacing, and Markdown syntax. |
There was a problem hiding this comment.
Nice, thanks for adding this. Do you plan on adding docs on how to create a new workspace type, register a plugin to be a part of a usecase etc?
Also how does workspaces work with permissions? Really curious to know how workspaces interact with the security plugin and tenants
Approving because this is good as is, but the added details would be really helpful :)
Thank you for the questions! That's really helpful, I will make sure these are well documented. |
Signed-off-by: Yulong Ruan <[email protected]> (cherry picked from commit f62795c) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
(cherry picked from commit f62795c) Signed-off-by: Yulong Ruan <[email protected]> Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Description
Add workspace design documentation
Issues Resolved
Screenshot
Testing the changes
Check List
yarn test:jestyarn test:jest_integration