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

Clarify device group read-only permission #772

Merged

Conversation

kprosise
Copy link
Contributor

The documentation was reworded. The changes should help clarify that members with read-only permission can still view other groups and devices.

QA: Viewed rendered html, edited with linter plugin. Ran linkcheck.

This commit addresses ticket FFTK-3602, "clarify device group read permission details"

PR Template and Checklist

Please complete as much as possible to speed up the reviewing process.

Readiness and adding reviewers as appropriate is required.

All PRs should be reviewed by a technical writer/documentation team and a peer.
If effecting customers—which is a majority of content changes—a member of Customer Success must also review.

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

Overview

Addresses point of confusion for customer

Checklist

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@doanac
Copy link
Member

doanac commented Nov 18, 2024

@vanmaegima
Copy link
Member

Maybe under https://ci.foundries.io/projects/fio-docs/builds/2798/docs/artifacts/html/user-guide/account-management/team-based-access.html#team-based-access-to-device-groups we can do add a note or something saying that device and CI/targets view are available for all users.

@doanac
Copy link
Member

doanac commented Nov 21, 2024

ci/targets can be blocked to a user in a team that's not given access to ci/targets. But a user in no team can view them

@kprosise
Copy link
Contributor Author

My mind is a bit jumbled now about what exactly we are trying to say. I will try to parse this all again soon.

@vanmaegima
Copy link
Member

@kprosise maybe we can have something in these lines:
Members in no teams can view all devices and ci/targets information. By default, they can only modify devices created by them.

Members of the "read-only-users" team have read-only access to all factory resources, including access to view all devices in a factory. They cannot make changes to the devices as their scope includes devices:read.

The "lab-dev-users" team includes devices:read-update scope.
Therefore, members of this team can modify the test-lab-devices group and its devices. They can also view all devices in a factory, even if they are assigned to other device groups.

@kprosise kprosise force-pushed the clarify-device-group-permission branch from cb06851 to 38db7f0 Compare December 5, 2024 17:06
@doanac
Copy link
Member

doanac commented Dec 5, 2024

@doanac
Copy link
Member

doanac commented Dec 6, 2024

The documentation was reworded. The changes should help clarify that
members with read-only permission can still view other groups and
devices.

QA: Viewed rendered html, edited with linter plugin. Ran linkcheck.

This commit addresses ticket FFTK-3602, "clarify device group read
permission details"

Signed-off-by: Katrina Prosise <katrina.prosise@foundries.io>
@kprosise kprosise force-pushed the clarify-device-group-permission branch from 293d758 to 546e1a5 Compare December 6, 2024 12:52
@doanac
Copy link
Member

doanac commented Dec 6, 2024

@kprosise kprosise merged commit 84c667f into foundriesio:main Dec 6, 2024
3 checks passed
@kprosise kprosise deleted the clarify-device-group-permission branch December 6, 2024 15:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants