-
Notifications
You must be signed in to change notification settings - Fork 107
Remove references to the Override checkbox for filters #3548
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
base: master
Are you sure you want to change the base?
Remove references to the Override checkbox for filters #3548
Conversation
|
The PR preview for 0e8616e is available at theforeman-foreman-documentation-preview-pr-3548.surge.sh The following output files are affected by this PR: |
| The *Unlimited* checkbox is selected by default, which means that the permission is applied on all resources of the selected type. | ||
| When you disable the *Unlimited* checkbox, the *Search* field activates. | ||
| . For certain *Resource type* options, the *Unlimited* checkbox is available. | ||
| If *Unlimited* is selected, the permission is applied on all resources of the selected type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We might want to add that unlimited will be disabled if the role parent has a loc/org selected, alert in foreman says: "Info alert:The filter is scoped to the selected organizations and locations, therefore can't be unlimited"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm inclined to say that we don't need to go into this kind of detail here. I left a comment on the code PR with a minor suggestion to change the wording of the alert. I'd say that if users will know what's happening from looking at the web UI form, then that's great and there is no need for additional words in the docs.
pnovotny
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
QA-wise LGTM
|
Thanks for the reviews, that covers tech review. |
Lennonka
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
|
Hi @MariaAga, as you're reviving theforeman/foreman#10370, can you please also take a look at this documentation PR? Is it still okay like this, or should I make any changes to address the latest state of the code PR? |
|
@aneta-petrova I added another change, and if it will be accepted I'll add details here 🙏 |
|
We have adjusted the developers PR to include more changes: |
|
@sourcery-ai review |
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThis PR removes all references to the filter-level override checkbox from permission-related documentation, updating the relevant procedures to reflect the removal of override functionality. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there - I've reviewed your changes and they look great!
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location> `guides/common/modules/proc_adding-permissions-to-a-role.adoc:14` </location>
<code_context>
-The *Unlimited* checkbox is selected by default, which means that the permission is applied on all resources of the selected type.
-When you disable the *Unlimited* checkbox, the *Search* field activates.
+. For certain *Resource type* options, the *Unlimited* checkbox is available.
+If *Unlimited* is selected, the permission is applied on all resources of the selected type.
+If *Unlimited* is unselected, the *Search* field activates.
In this field you can specify further filtering with use of the {Project} search syntax.
</code_context>
<issue_to_address>
**suggestion (review_instructions):** The sentence uses passive voice ('is applied'), which should be revised to active voice for clarity.
Consider rephrasing to active voice, such as: 'Selecting *Unlimited* applies the permission to all resources of the selected type.'
<details>
<summary>Review instructions:</summary>
**Path patterns:** `guides/common/*.adoc,guides/common/modules/*.adoc`
**Instructions:**
Avoid passive voice in verbs.
</details>
</issue_to_address>
### Comment 2
<location> `guides/common/modules/proc_adding-permissions-to-a-role.adoc:15` </location>
<code_context>
-When you disable the *Unlimited* checkbox, the *Search* field activates.
+. For certain *Resource type* options, the *Unlimited* checkbox is available.
+If *Unlimited* is selected, the permission is applied on all resources of the selected type.
+If *Unlimited* is unselected, the *Search* field activates.
In this field you can specify further filtering with use of the {Project} search syntax.
For more information, see xref:Granular_Permission_Filtering_{context}[].
</code_context>
<issue_to_address>
**suggestion (review_instructions):** The phrase 'is unselected' uses passive voice; prefer active voice for instructions.
You could rephrase as: 'If you clear *Unlimited*, the *Search* field activates.'
<details>
<summary>Review instructions:</summary>
**Path patterns:** `guides/common/*.adoc,guides/common/modules/*.adoc`
**Instructions:**
Avoid passive voice in verbs.
</details>
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| The *Unlimited* checkbox is selected by default, which means that the permission is applied on all resources of the selected type. | ||
| When you disable the *Unlimited* checkbox, the *Search* field activates. | ||
| . For certain *Resource type* options, the *Unlimited* checkbox is available. | ||
| If *Unlimited* is selected, the permission is applied on all resources of the selected type. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (review_instructions): The sentence uses passive voice ('is applied'), which should be revised to active voice for clarity.
Consider rephrasing to active voice, such as: 'Selecting Unlimited applies the permission to all resources of the selected type.'
Review instructions:
Path patterns: guides/common/*.adoc,guides/common/modules/*.adoc
Instructions:
Avoid passive voice in verbs.
| When you disable the *Unlimited* checkbox, the *Search* field activates. | ||
| . For certain *Resource type* options, the *Unlimited* checkbox is available. | ||
| If *Unlimited* is selected, the permission is applied on all resources of the selected type. | ||
| If *Unlimited* is unselected, the *Search* field activates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (review_instructions): The phrase 'is unselected' uses passive voice; prefer active voice for instructions.
You could rephrase as: 'If you clear Unlimited, the Search field activates.'
Review instructions:
Path patterns: guides/common/*.adoc,guides/common/modules/*.adoc
Instructions:
Avoid passive voice in verbs.
What changes are you introducing?
I'm removing references to the ability to override organizations and locations on the filter level.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
The option to override orgs and locs on the filter level is being removed in theforeman/foreman#10370
Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Checklists
Please cherry-pick my commits into:
Summary by Sourcery
Documentation: