Skip to content

Document new usage metrics timer #3973

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

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

Conversation

aneta-petrova
Copy link
Member

What changes are you introducing?

Adding information about a new timer that collects usage metrics from Satellite.

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

theforeman/foreman_maintain#996

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.15/Katello 4.17
  • Foreman 3.14/Katello 4.16 (Satellite 6.17)
  • 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.

Review checklists

Tech review (performed by an Engineer who did not author the PR; can be skipped if tech review is unnecessary):

  • The PR documents a recommended, user-friendly path.
  • The PR removes steps that have been made unnecessary or obsolete.
  • Any steps introduced or updated in the PR have been tested to confirm that they lead to the documented end result.

Style review (by a Technical Writer who did not author the PR):

  • The PR conforms with the team's style guidelines.
  • The PR introduces documentation that describes a user story rather than a product feature.

@aneta-petrova aneta-petrova added Waiting for code Requires merge of related code in another repository before it can be merged and removed Not yet reviewed labels Jul 2, 2025
@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 Jul 2, 2025
Copy link

github-actions bot commented Jul 2, 2025

The PR preview for 0cd6b2e is available at theforeman-foreman-documentation-preview-pr-3973.surge.sh

The following output files are affected by this PR:

show diff

show diff as HTML

@aneta-petrova
Copy link
Member Author

Hi @adamruzicka and @pondrejk , can you please review?

@aneta-petrova aneta-petrova removed the Needs style review Requires a review from docs style/grammar perspective label Jul 2, 2025
@aneta-petrova aneta-petrova marked this pull request as ready for review July 2, 2025 15:02
@aneta-petrova aneta-petrova added the Needs style review Requires a review from docs style/grammar perspective label Jul 2, 2025
Copy link
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

one comment, rest LGTM style wise.

@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 Jul 3, 2025
Copy link
Contributor

@maximiliankolb maximiliankolb left a comment

Choose a reason for hiding this comment

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

style-wise LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs tech review Requires a review from the technical perspective Needs testing Requires functional testing 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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants