Commits on Aug 12, 2024

1. Rewrite documentation URL mapping to use the TOC …

   Upstream builds various guides and each guide is built as a single large
   page. That page has many chapters. Technically every guide is also built
   into 3 flavors (foreman-deb, foreman-el, katello).
   
   Downstream builds various guides, which mostly come from upstream. Most
   guides are a simple translation where they're downcased, but some are
   rewritten to something else.
   
   A bigger difference is that each guide is built into multiple pages.
   This means we need to find the right page containing the chapter. The
   Table of Content contains a complete mapping with this information, so
   it can be looked up dynamically.
   
   If this still can't be found, we use the html-single where everything is
   built into a single page. We then just hope it exists. Otherwise the
   browser will just show the whole page. This is an unexpected case, so a
   warning is logged.
   
   The result is that a lot less maintenance is needed, because in most
   cases it will "just work". A downside is that it becomes hard to verify
   links are correct. It becomes needed to crawl through all of the source
   code for any documentation links, similar to how we crawl through it for
   translations.

   

   ekohl committed Aug 12, 2024
   Configuration menu

   • View commit details
   • Copy full SHA for 4dfad0b
   • Browse repository at this point

   Copy the full SHA

   4dfad0b View commit details

   Browse the repository at this point in the history