foreman-documentation icon indicating copy to clipboard operation
foreman-documentation copied to clipboard

Remove references to the Override checkbox for filters

Open aneta-petrova opened this issue 1 year ago • 8 comments

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 https://github.com/theforeman/foreman/pull/10370

Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)

Checklists

  • [x] I am okay with my commits getting squashed when you merge this PR.
  • [x] 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 avatar Jan 06 '25 09:01 aneta-petrova

I asked @MariaAga and @pnovotny for tech review.

aneta-petrova avatar Jan 06 '25 12:01 aneta-petrova

Thanks for the reviews, that covers tech review.

aneta-petrova avatar Jan 16 '25 10:01 aneta-petrova

Hi @MariaAga, as you're reviving https://github.com/theforeman/foreman/pull/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 avatar Jul 28 '25 11:07 aneta-petrova

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

MariaAga avatar Jul 28 '25 11:07 MariaAga

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

MariaAga avatar Oct 14 '25 11:10 MariaAga

@sourcery-ai review

aneta-petrova avatar Nov 13 '25 13:11 aneta-petrova

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

  • Contact our support team for questions or feedback.
  • Visit our documentation for detailed guides and information.
  • Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai[bot] avatar Nov 13 '25 13:11 sourcery-ai[bot]