Skip to content

[IMP] Access Rights: Technical Access Rights #12830

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

Closed

Conversation

justinmallette
Copy link
Contributor

@justinmallette justinmallette commented Apr 8, 2025

Added content for technical access rights from 18.2 update

https://www.odoo.com/odoo/project/3835/tasks/4710794

@justinmallette justinmallette self-assigned this Apr 8, 2025
@robodoo
Copy link
Collaborator

robodoo commented Apr 8, 2025

Pull request status dashboard

@samueljlieber samueljlieber changed the base branch from saas-18.2 to 18.0 April 8, 2025 16:12
@samueljlieber samueljlieber changed the base branch from 18.0 to saas-18.2 April 8, 2025 16:12
@C3POdoo C3POdoo requested a review from a team April 8, 2025 16:15
@justinmallette
Copy link
Contributor Author

@Felicious ready for peer review

Copy link
Contributor

@Felicious Felicious left a comment

Choose a reason for hiding this comment

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

Hi @justinmallette! 😊 I just did a quick content review, and everything looks good to me!

I trust the SME will give solid feedback if more depth is needed, so feel free to defer to their input on that.

@justinmallette justinmallette force-pushed the 18.2-access-rights-tech-rights-juma branch 2 times, most recently from d679d0f to 208c2a2 Compare April 10, 2025 19:59
@justinmallette
Copy link
Contributor Author

@StraubCreative ready for final review

Copy link
Contributor

@StraubCreative StraubCreative left a comment

Choose a reason for hiding this comment

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

Hi @justinmallette

Thank you for jumping on this contribution so quickly in time with our current product version and at the request of an expert.

I like the additions you made here, and am approving with a few comments for you to consider around craft, specificity, and depth.

You may also want to consider adding a screenshot of the form view to capture that new Technical Access Rights tab to underscore its intended functionality as a "quality of life" accessibility feature.

Please feel free to move to TR when you're ready, and thanks again!

@@ -102,8 +144,8 @@ The group form contains multiple tabs for managing all elements of the group. In
- :guilabel:`Views` tab: lists which views in Odoo the group has access to. Click :guilabel:`Add a
line` to add a view to the group.
- :guilabel:`Access Rights` tab: lists the first level of rights (models) that this group has. The
:guilabel:`Name` column represents the name for the current group's access to the model
selected in the :guilabel:`Model` column.
:guilabel:`Name` column represents the name for the current group's access to the model selected
Copy link
Contributor

Choose a reason for hiding this comment

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

Optional fix, on line 142.

content/applications/general/users/access_rights.rst:142: consider moving ":guilabel:`Add" to line 142 (early-line-breaks)
make: *** [review] Error 1

but their ability to manage their own timesheets restricted (e.g., if the payroll administrator is
salaried and does not need to manage their own timesheets).

Manage specific permissions requires :ref:`developer mode <developer-mode>`. After that, navigate to
Copy link
Contributor

Choose a reason for hiding this comment

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

Grammar.
I would use gerund form of "manage" and add a form of "to be" as the determiner here:

Suggested change
Manage specific permissions requires :ref:`developer mode <developer-mode>`. After that, navigate to
Managing specific permissions requires :ref:`developer mode <developer-mode>` to be enabled. After that, navigate to

...however, this version works too (and might be more "Odoo-y" 😉 ):

Suggested change
Manage specific permissions requires :ref:`developer mode <developer-mode>`. After that, navigate to
To manage specific permissions, :ref:`developer mode <developer-mode>` must be enabled.

Comment on lines 65 to 66
:menuselection:`Settings app`, and then click :guilabel:`Manage users`, select a user, and go to the
:guilabel:`Technical Access Rights` tab. From here, groups can be edited (which is covered in the
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestions for flow (following the last part of line 64): added a missing article, cleaned up the comma splices so the actions strung together there have clean breaks and conjunctions.

Suggested change
:menuselection:`Settings app`, and then click :guilabel:`Manage users`, select a user, and go to the
:guilabel:`Technical Access Rights` tab. From here, groups can be edited (which is covered in the
the :menuselection:`Settings` app. Then click :guilabel:`Manage Users`, select a user, and go to the
:guilabel:`Technical Access Rights` tab.

Comment on lines 66 to 67
:guilabel:`Technical Access Rights` tab. From here, groups can be edited (which is covered in the
next section) and specific access rights can be managed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
:guilabel:`Technical Access Rights` tab. From here, groups can be edited (which is covered in the
next section) and specific access rights can be managed.
From here, groups can be edited and specific access rights can be managed.

Comment on lines 66 to 71
:guilabel:`Technical Access Rights` tab. From here, groups can be edited (which is covered in the
next section) and specific access rights can be managed.

In the :guilabel:`Groups` section, these specific access rights are organized by groups and are
split into sections. If no changes are made to these groups, then their permissions will mirror the
selections made in the :guilabel:`Access Rights` tab.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestions to be more concise: remove parenthesis and line 69 which struck me as redundant (e.g. "In the groups section...[which] are organized by groups...and sections")

Suggested change
:guilabel:`Technical Access Rights` tab. From here, groups can be edited (which is covered in the
next section) and specific access rights can be managed.
In the :guilabel:`Groups` section, these specific access rights are organized by groups and are
split into sections. If no changes are made to these groups, then their permissions will mirror the
selections made in the :guilabel:`Access Rights` tab.
From here, :guilabel:`Groups` can be edited, and specific access rights can be managed across the
various sections. If no changes are made to these *Groups*, then their permissions will mirror the
selections made in the :guilabel:`Access Rights` tab.

can be given these permissions by clicking on the permission itself, and then adding the user to
that permission's group.

.. note::
Copy link
Contributor

Choose a reason for hiding this comment

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

Good detail! I was wondering what the colors and italics meant!

Comment on lines 73 to 76
- :guilabel:`Selected groups`: access rights set by choices made in the :guilabel:`Access Rights`
tab
- :guilabel:`Groups added automatically`: access rights given as part of the access rights provided
by the :guilabel:`Selected groups`
Copy link
Contributor

Choose a reason for hiding this comment

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

Indeed, these are a bit challenging to define since they are a) a part of a new undocumented feature and b) the tooltips on the UI surrounding the section headings are a bit lame 😄

Here's what I dug up with the input of SUP and RD team members, who helped piece it together.

Suggested change
- :guilabel:`Selected groups`: access rights set by choices made in the :guilabel:`Access Rights`
tab
- :guilabel:`Groups added automatically`: access rights given as part of the access rights provided
by the :guilabel:`Selected groups`
- :guilabel:`Selected groups`: a list of detailed access rights, set by choices made in the
:guilabel:`Access Rights` tab.
- :guilabel:`Groups added automatically`: *implied* permissions that are *inherited* with the
explicit permissions already granted to the user. The values here will match the values listed
under a given *Group*'s form located under the :menuselection:` Users & Companies --> Groups`
menu, in the :guilabel:`Inherited` tab.
.. example::
When the *Sales Administrator* permission set is assigned to a user, then the *Canned Responses
Administrator* permissions are inherited automatically. These assignments are reflected across
the values listed in the :guilabel:`Selected Groups` and :guilabel:`Groups added automatically`
tables, respectively.

I like the deep definition, how the new sections connect to familiar UI/forms in past versions, and the example block as supplemental context before we get into performing specific, high-impact actions with the rows in the tables. I hope this helps and you find it useful— take what you like, please 🙏

Comment on lines +78 to +93
To add a permission to this user profile, click :guilabel:`Add a line` in the :guilabel:`Selected
groups` table, and then add permissions to this user profile. To remove a permission, click the
:icon:`fa-times` :guilabel:`(cancel)` at the end of that permission's row.
Copy link
Contributor

Choose a reason for hiding this comment

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

Would mention here that removing permissions may have further permission removal consequences in the Groups added automatically table, since one informs the other. Maybe a warning block would be a useful format to emphasize this?

@justinmallette justinmallette force-pushed the 18.2-access-rights-tech-rights-juma branch from 1f46cee to e4af1c2 Compare April 15, 2025 17:07
@justinmallette
Copy link
Contributor Author

justinmallette commented Apr 15, 2025

@StraubCreative github was blocking me from merging a batch, so your edits were added by hand in case you're wondering why they were left open!


@samueljlieber ready for TR

Copy link
Contributor

@samueljlieber samueljlieber left a comment

Choose a reason for hiding this comment

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

Hi @justinmallette, nice work on this doc! Your changes look great to me, approving with a couple comments for your consideration!

Thank you for your work!
..
@robodoo delegate=justinmallette

Comment on lines 78 to 79
under a given *Group*'s form located under the :menuselection:` Users & Companies --> Groups`
menu, in the :guilabel:`Inherited` tab.
Copy link
Contributor

Choose a reason for hiding this comment

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

No need to add formatting to "group's", fix menuselection formatting, and add the app to beginning of the menu for clarity of instruction

Suggested change
under a given *Group*'s form located under the :menuselection:` Users & Companies --> Groups`
menu, in the :guilabel:`Inherited` tab.
under a given group's form located under the :menuselection:`Settings --> Users & Companies -->
Groups` menu, in the :guilabel:`Inherited` tab.

Copy link
Contributor

Choose a reason for hiding this comment

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

I wrote it this way on purpose so I'd say this suggestion is optional @justinmallette

  • Group is referencing a section on the UI / Odoo feature so italicized like this is also fine
  • Adding Settings in the menuselection is fine however we're already in the Settings at this point so can just point to the menu that should be present anyway.

Comment on lines +85 to +89
When the *Sales Administrator* permission set is assigned to a user, then the *Canned Responses
Administrator* permissions are inherited automatically. These assignments are reflected across
the values listed in the :guilabel:`Selected Groups` and :guilabel:`Groups added automatically`
tables, respectively.
Copy link
Contributor

Choose a reason for hiding this comment

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

To be precise with matching the UI, I recommend restating like so with :guilabel:s for the UI text

Suggested change
When the *Sales Administrator* permission set is assigned to a user, then the *Canned Responses
Administrator* permissions are inherited automatically. These assignments are reflected across
the values listed in the :guilabel:`Selected Groups` and :guilabel:`Groups added automatically`
tables, respectively.
When the :guilabel:`Sales` app's :guilabel:`Administrator` permission is assigned to a user, then
the :guilabel:`Canned Responses Administrator` permissions are inherited automatically. These
assignments are reflected across the values listed in the :guilabel:`Selected Groups` and
:guilabel:`Groups added automatically` tables, respectively.

Copy link
Contributor

Choose a reason for hiding this comment

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

We're entertaining a hypothetical example, we do not need guis here

Co-authored-by: Felicia Kuan <[email protected]>
Co-authored-by: Zachary Straub <[email protected]>
Co-authored-by: Sam Lieber (sali) <[email protected]>
@justinmallette justinmallette force-pushed the 18.2-access-rights-tech-rights-juma branch from 285e1b3 to 9f80f79 Compare April 17, 2025 15:30
@justinmallette
Copy link
Contributor Author

@robodoo r+

robodoo pushed a commit that referenced this pull request Apr 17, 2025
closes #12830

Signed-off-by: Justin Mallette (juma) <[email protected]>
Co-authored-by: Felicia Kuan <[email protected]>
Co-authored-by: Zachary Straub <[email protected]>
Co-authored-by: Sam Lieber (sali) <[email protected]>
@robodoo robodoo closed this Apr 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants