Skip to content
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 documentation for workspace privacy #8994

Open
wants to merge 10 commits into
base: main
Choose a base branch
from

Conversation

Kapian1234
Copy link

@Kapian1234 Kapian1234 commented Jan 2, 2025

Description

Add documentation for workspace privacy settings.

Issues Resolved

Closes #8993

Version

2.19

Frontend features

Workspace privacy

Screen.Recording.2025-01-02.at.17.32.02.mov

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

github-actions bot commented Jan 2, 2025

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@kolchfa-aws kolchfa-aws added release-notes PR: Include this PR in the automated release notes v2.19.0 labels Jan 2, 2025
@Naarcha-AWS Naarcha-AWS added the 4 - Doc review PR: Doc review in progress label Jan 2, 2025
@SuZhou-Joe
Copy link
Member

Hi @Naarcha-AWS , we have a following PR: opensearch-project/OpenSearch-Dashboards#9168 depends on merge of this doc PR. May I know when can we review and merge this PR?

Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Jan 13, 2025
@Naarcha-AWS
Copy link
Collaborator

@SuZhou-Joe: Added my edits to this PR and passed this to editorial review.

Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS Please see my comments and changes and tag me for approval when addressed. Thanks!

_dashboards/workspace/workspace-acl.md Outdated Show resolved Hide resolved
_dashboards/workspace/workspace-acl.md Outdated Show resolved Hide resolved
_dashboards/workspace/workspace-acl.md Outdated Show resolved Hide resolved
_dashboards/workspace/workspace-acl.md Outdated Show resolved Hide resolved
_dashboards/workspace/workspace-acl.md Outdated Show resolved Hide resolved
Use the following steps to edit the workplace privacy settings on the **Collaborators** page:

1. Select the **Edit** button at the upper-right corner of the **Details** panel.
2. Select the new access level from the dropdown.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. Select the new access level from the dropdown.

1. Select the **Edit** button at the upper-right corner of the **Details** panel.
2. Select the new access level from the dropdown.
3. Select **Save** to apply the modifications.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 191 and subsequent is repeated text.

_dashboards/workspace/workspace-acl.md Outdated Show resolved Hide resolved
_dashboards/workspace/workspace-acl.md Outdated Show resolved Hide resolved

Use the following steps to edit the workplace privacy settings on the **Collaborators** page:

1. Next to **Workplace privacy**, select **Edit**.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Workplace" ="Workspace"?

Naarcha-AWS and others added 2 commits January 14, 2025 10:53
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Naarcha-AWS @Kapian1234 Approval pending confirmation of UI element change.

Use the following steps to change workspace privacy settings when creating a new workspace:

1. Choose the desired access level from the **Set up privacy** panel.
2. _Optional_ Decide whether to add collaborators after workspace creation by selecting the **Go to configure the collaborators right after creating the workspace.** checkbox.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to confirm that the name of the checkbox is changed to something like "Add collaborators after workspace creation".

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress release-notes PR: Include this PR in the automated release notes v2.19.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation for workspace privacy settings
6 participants