Skip to content

Correct default number of items per page #4312

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Correct default number of items per page #4312

wants to merge 5 commits into from

Conversation

@waldirio
Copy link

What changes are you introducing?

Fixing the wrong information.

Why are you introducing these changes? (Explanation, links to references, issues, etc.)

It's not accurate.

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

Contributor 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.16/Katello 4.18 (Satellite 6.18)
  • Foreman 3.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4)
  • Foreman 3.13/Katello 4.15 (EL9 only)
  • Foreman 3.12/Katello 4.14 (Satellite 6.16; orcharhino 7.2 on EL9 only; orcharhino 7.3)
  • Foreman 3.11/Katello 4.13 (orcharhino 6.11 on EL8 only; orcharhino 7.0 on EL8+EL9; orcharhino 7.1 with Leapp)
  • Foreman 3.10/Katello 4.12
  • Foreman 3.9/Katello 4.11 (Satellite 6.15; orcharhino 6.8/6.9/6.10)
  • We do not accept PRs for Foreman older than 3.9.

@github-actions github-actions bot added Needs tech review Requires a review from the technical perspective Needs style review Requires a review from docs style/grammar perspective Needs testing Requires functional testing labels Sep 26, 2025
@github-actions
Copy link

github-actions bot commented Sep 26, 2025 •
edited
Loading

The PR preview for c56797d is available at theforeman-foreman-documentation-preview-pr-4312.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

Lennonka
Lennonka requested changes Sep 29, 2025
View reviewed changes
@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label Sep 29, 2025
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author Needs re-review labels Sep 29, 2025
@ekohl ekohl changed the title Fixes_38779 - Fixing the wrong information in the doc Correct default number of items per page Sep 29, 2025
Lennonka
Lennonka requested changes Sep 29, 2025
View reviewed changes
@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label Sep 29, 2025
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author Needs re-review labels Sep 29, 2025
Lennonka
Lennonka requested changes Sep 29, 2025
View reviewed changes
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.

Almost there

@pr-processor pr-processor bot added the Waiting on contributor Requires an action from the author label Sep 29, 2025
@pr-processor pr-processor bot added Needs re-review and removed Waiting on contributor Requires an action from the author Needs re-review labels Sep 29, 2025
@aneta-petrova aneta-petrova removed the Needs style review Requires a review from docs style/grammar perspective label Sep 30, 2025
@aneta-petrova aneta-petrova added the style review done No issues from docs style/grammar perspective label Sep 30, 2025
@aneta-petrova
Copy link
Member

Thanks @waldirio! You have my ack :) Now we need a tech ack to confirm the technical validity of the change. I'll ask the engineers.

@aneta-petrova
Copy link
Member

@waldirio Do you happen to know which versions of Foreman/Satellite this applies to? Just so we know which versions the fix should be cherry-picked to.

@aneta-petrova aneta-petrova added testing done No issues from the functional perspective and removed Needs testing Requires functional testing labels Sep 30, 2025
@aneta-petrova
Copy link
Member

I'm setting testing done per the report and conversation in https://issues.redhat.com/browse/SAT-35429.

ekohl
ekohl reviewed Sep 30, 2025
View reviewed changes
Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

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

Should we mention the entries_per_page setting?

guides/common/modules/proc_using-searches-with-pagination-control.adoc
The `per_page` parameter specifies the number of results per page and the `page` parameter specifies which page, as calculated by the `per_page` parameter, to return.

The default number of items to return is set to 1000 when you do not specify any pagination parameters, but the `per_page` value has a default of 20 which applies when you specify the `page` parameter.
The default number of items to be presented is set to `20`.
Copy link
Member

Choose a reason for hiding this comment

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

https://github.com/theforeman/foreman/blob/d048dc1e435cf3dd5d391607cdc7928f6713ee87/config/initializers/core_extensions.rb#L13-L18 is the logic for that. So it's the entries_per_page setting with a fallback to 20. The entries_per_page setting also defaults to 20 (https://github.com/theforeman/foreman/blob/d048dc1e435cf3dd5d391607cdc7928f6713ee87/config/initializers/f_foreman_settings_general.rb#L18-L22) but can obviously be changed by users.

This behavior dates back to theforeman/foreman@454fd3a (2011).

Copy link
Member

Choose a reason for hiding this comment

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

Hi @ekohl, would it be okay to create a new issue for your comment? What I'm taking from this is that @waldirio's PR is correct as is and if that's the case, I'd rather accept it and track your suggestion in an issue.

Copy link
Member

Choose a reason for hiding this comment

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

Technically @waldirio is only correct for installations where the entries_per_page setting is set to 20. By default that's true, but it doesn't have to be.

I'd suggest something like:

The number of items to be presented is set using the setting entries_per_page, which defaults to 20.
However, you can change it per request by using the parameter per_page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ekohl ekohl ekohl left review comments

@aneta-petrova aneta-petrova aneta-petrova approved these changes

@Lennonka Lennonka Lennonka requested changes

Assignees

No one assigned

Labels

Needs tech review Requires a review from the technical perspective style review done No issues from docs style/grammar perspective testing done No issues from the functional perspective

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@waldirio @aneta-petrova @ekohl @Lennonka