WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Conversation

@jafiala
Copy link
Contributor

@jafiala jafiala commented Nov 28, 2025

What changes are you introducing?

Further adjust newly added files for downstream docs

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

Conclusion of #4422

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.17/Katello 4.19
  • 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.

Summary by Sourcery

Update bootloader reference documentation for HTTP and shared TFTP/HTTP usage and remove obsolete iPXE-specific module.

Documentation:

  • Add new reference modules documenting HTTP bootloaders and shared TFTP/HTTP root configuration.
  • Adjust bootloader binary location assembly to use the new reference modules and drop the deprecated iPXE bootloaders reference.

@sourcery-ai
Copy link

sourcery-ai bot commented Nov 28, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Reorganizes and consolidates boot loader reference documentation by replacing the ipxe-specific reference module with more generic HTTP and shared TFTP/HTTP root reference modules and wiring them into the main bootloader binary location assembly.

File-Level Changes

Change Details Files
Update bootloader binary location assembly to reference new shared modules instead of the removed iPXE-specific one.
  • Adjust includes or cross-references in the bootloader binary location assembly to use the new HTTP bootloader and shared TFTP/HTTP root reference modules
  • Remove references to the deprecated ipxe bootloader reference module within the assembly
guides/common/assembly_bootloader-binary-location.adoc
Introduce reusable reference content for HTTP bootloaders.
  • Create a new reference module describing HTTP bootloader locations and usage
  • Structure the content so it can be included from multiple downstream docs
guides/common/modules/ref_http-bootloaders.adoc
Introduce reusable reference content for the shared TFTP/HTTP root.
  • Create a new reference module explaining the shared TFTP/HTTP root structure and paths
  • Ensure headings/ids align with existing docs conventions for downstream reuse
guides/common/modules/ref_shared-tftp-http-root.adoc
Remove the old iPXE-specific bootloader reference module in favor of the new, more generic modules.
  • Delete the ipxe bootloaders reference module file
  • Migrate its relevant information into the new HTTP and shared TFTP/HTTP root modules where applicable
guides/common/modules/ref_ipxe-bootloaders.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

@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 Nov 28, 2025
@github-actions
Copy link

github-actions bot commented Nov 28, 2025

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

Labels

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants