DITAfication of the tuning guide

[AkshayGadhaveRH]

JIRA:
https://issues.redhat.com/browse/SAT-36308

• 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; orcharhino 7.6)
• Foreman 3.15/Katello 4.17
• Foreman 3.14/Katello 4.16 (Satellite 6.17; orcharhino 7.4; orcharhino 7.5)
• 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)
• We do not accept PRs for Foreman older than 3.12.

[AkshayGadhaveRH]

Basic changes pushed so far. This PR is WIP.

[github-actions]

The PR preview for 2a71967 is available at theforeman-foreman-documentation-preview-pr-4630.surge.sh

The following output files are affected by this PR:

• Tuning_Performance/index-foreman-deb.html
• Tuning_Performance/index-foreman-el.html
• Tuning_Performance/index-foremanctl-katello.html
• Tuning_Performance/index-foremanctl-orcharhino.html
• Tuning_Performance/index-foremanctl-satellite.html
• Tuning_Performance/index-katello.html
• Tuning_Performance/index-orcharhino.html
• Tuning_Performance/index-satellite.html

show diff

show diff as HTML

[jafiala]

LGTM

[maximiliankolb]

LGTM

[Lennonka]

If you haven't made any factual changes, the PR doesn't need tech review.
We should generally avoid changes requiring tech review in DITAfication PRs.

[AkshayGadhaveRH]

Hey @Lennonka just changed some modules types based on their contents. The only changes apart from that are adding an abstract and dropping unsupported block titles. I don't think these require a tech review, hence dropped the tech review label.

[maximiliankolb]

LGTM!

[Lennonka]

I've run the DITA Vale test. This needs more work.

 common/modules/con_postgresql-tuning.adoc
 4:1   warning  Assign [role="_abstract"]       AsciiDocDITA.ShortDescription 
                to a paragraph to use it as                                   
                <shortdesc> in DITA.                                          
 15:1  warning  Block titles can only be        AsciiDocDITA.BlockTitle       
                assigned to examples, figures,                                
                and tables in DITA.  

common/modules/con_redis-tuning.adoc
 4:1  warning  Assign [role="_abstract"]       AsciiDocDITA.ShortDescription 
               to a paragraph to use it as                                   
               <shortdesc> in DITA.

 common/modules/con_smart-proxy-configuration-tuning.adoc
 4:1  warning  Assign [role="_abstract"]       AsciiDocDITA.ShortDescription 
               to a paragraph to use it as                                   
               <shortdesc> in DITA.

common/modules/con_smartproxy-performance-tests.adoc
 4:1   warning  Assign [role="_abstract"]       AsciiDocDITA.ShortDescription 
                to a paragraph to use it as                                   
                <shortdesc> in DITA.                                          
 17:1  warning  Block titles can only be        AsciiDocDITA.BlockTitle       
                assigned to examples, figures,                                
                and tables in DITA.                                           
 30:1  warning  Block titles can only be        AsciiDocDITA.BlockTitle       
                assigned to examples, figures,                                
                and tables in DITA.                                           
 43:1  warning  Block titles can only be        AsciiDocDITA.BlockTitle       
                assigned to examples, figures,                                
                and tables in DITA.

common/modules/proc_benchmarking-raw-db-performance.adoc
 1:1  warning  The '.Procedure' block title    AsciiDocDITA.TaskContents     
               is missing.                                                   
 4:1  warning  Assign [role="_abstract"]       AsciiDocDITA.ShortDescription 
               to a paragraph to use it as                                   
               <shortdesc> in DITA.

common/modules/proc_decreasing-performance-impact-of-the-pull-based-rex-transport.adoc
 34:1  warning  Content other than a single     AsciiDocDITA.TaskStep 
                list cannot be mapped to DITA                         
                tasks. 

common/modules/proc_dynflow-tuning.adoc
 43:1  warning  Content other than a single     AsciiDocDITA.TaskStep 
                list cannot be mapped to DITA                         
                tasks.

common/modules/proc_manually-tuning-puma-workers-and-threads-count.adoc
 1:1  warning  The '.Procedure' block title    AsciiDocDITA.TaskContents 
               is missing. 

[AkshayGadhaveRH]

Hey @Lennonka
Addressed most of the leftover flags, except for

common/modules/proc_decreasing-performance-impact-of-the-pull-based-rex-transport.adoc
 34:1  warning  Content other than a single     AsciiDocDITA.TaskStep 
                list cannot be mapped to DITA                         
                tasks. 

The lines flagged are the following (flagged as these appear under the procedure header):

{SmartProxyServer} logs are in `/var/log/foreman-proxy/proxy.log`.
{SmartProxyServer} uses Webrick HTTP server (no httpd or Puma involved), so there is no simple way to increase its capacity.

ifndef::orcharhino[]
[NOTE]
====
Depending on the workload, number of hosts, available resources, and applied tuning, you might hit the https://bugzilla.redhat.com/show_bug.cgi?id=2244811[Bug 2244811], which causes {SmartProxy} to consume too much memory and eventually be killed, making the rest of the job fail.
At the moment there is no universally applicable workaround.
====
endif::[]

The line about the logs can be removed IMO.

The Webrick HTTP server can probably moved to the intro section above.

I think the NOTE can be removed too as the bug is closed.

I'll check with Imaanpreet once about this once and then make the changes.