Skip to content

Conversation

@aneta-petrova
Copy link
Member

@aneta-petrova aneta-petrova commented Jan 6, 2025

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

  • I am okay with my commits getting squashed when you merge this PR.
  • I am familiar with the contributing guidelines.

Please cherry-pick my commits into:

  • Foreman 3.13/Katello 4.15
  • Foreman 3.12/Katello 4.14 (Satellite 6.16)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • Foreman 3.8/Katello 4.10
  • Foreman 3.7/Katello 4.9 (Satellite 6.14)
  • We do not accept PRs for Foreman older than 3.7.

Summary by Sourcery

Documentation:

  • Remove mentions of the 'Override' checkbox for organizations and locations in filter settings across guide modules.

@aneta-petrova aneta-petrova added Needs tech review Requires a review from the technical perspective Waiting for code Requires merge of related code in another repository before it can be merged and removed Not yet reviewed labels Jan 6, 2025
@aneta-petrova
Copy link
Member Author

I asked @MariaAga and @pnovotny for tech review.

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.
Copy link
Member

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"

Copy link
Member Author

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.

Copy link

@pnovotny pnovotny left a comment

Choose a reason for hiding this comment

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

QA-wise LGTM

@aneta-petrova
Copy link
Member Author

Thanks for the reviews, that covers tech review.

@aneta-petrova aneta-petrova added tech review done No issues from the technical perspective Needs style review Requires a review from docs style/grammar perspective and removed Needs tech review Requires a review from the technical perspective labels Jan 16, 2025
Copy link
Contributor

@Lennonka Lennonka left a comment

Choose a reason for hiding this comment

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

LGTM

@aneta-petrova aneta-petrova added style review done No issues from docs style/grammar perspective and removed Needs style review Requires a review from docs style/grammar perspective labels Jan 21, 2025
@aneta-petrova aneta-petrova deleted the orgs-locs-filter-level branch January 23, 2025 11:34
@aneta-petrova aneta-petrova restored the orgs-locs-filter-level branch January 23, 2025 11:44
@aneta-petrova aneta-petrova reopened this Jan 23, 2025
@aneta-petrova
Copy link
Member Author

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?

@MariaAga
Copy link
Member

@aneta-petrova I added another change, and if it will be accepted I'll add details here 🙏

@MariaAga
Copy link
Member

We have adjusted the developers PR to include more changes:
Removes override and unlimited checkboxes from filter forms and database schema - so no more override (taxonomies) in the filter level, and the unlimited checkbox is gone (previously if a filter has unlimited = true, it meant that it didnt have a taxonomy or search set. Since roles will always have a taxonomy, and the filter will inherit it, the unlimited field didnt make sense anymore, as it will always be false)
Simplifies filter creation to always inherit role taxonomies automatically
Updates UI to show inherited organizations and locations as read-only fields

@aneta-petrova aneta-petrova removed tech review done No issues from the technical perspective style review done No issues from docs style/grammar perspective Waiting for code Requires merge of related code in another repository before it can be merged labels Oct 29, 2025
@aneta-petrova
Copy link
Member Author

@sourcery-ai review

@sourcery-ai
Copy link

sourcery-ai bot commented Nov 13, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This 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

Change Details Files
Removed override checkbox references from permission process guides
  • Deleted instructions mentioning the override checkbox in procedure steps
  • Omitted filter-level override examples and notes
  • Adjusted related procedure descriptions to exclude override functionality
guides/common/modules/proc_adding-permissions-to-a-role.adoc
guides/common/modules/proc_applying-permissions-for-the-host-resource-type.adoc
guides/common/modules/proc_creating-an-organization-specific-manager-role.adoc

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a 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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
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.
Copy link

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.
Copy link

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.

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.

4 participants