Skip to content

Adjust branding to changes in foreman_puppet #316

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

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

Adjust branding to changes in foreman_puppet #316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f6042af
Update TOC file from downstream
Mar 5, 2026
cbb0bcb
Adjust doc links to TOC changes
adamruzicka Mar 2, 2026
7698b29
Drop branding for obsolete SCAP links
adamruzicka Mar 5, 2026
5d91093
Adjust puppet doc link to TOC changes
adamruzicka Mar 5, 2026
153fc45
Adjust branding to changes in foreman_puppet
adamruzicka Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions lib/foreman_theme_satellite/documentation.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,8 @@ module Documentation
'Networking' => "provisioning_hosts/index#adding-a-subnet-to-server-by-using-web-ui",

# Puppet Guide
'FactsandtheENC' => "managing_configurations_by_using_puppet_integration/index#performing-configuration-management_managing-configurations-puppet",
'using-config-groups' => "managing_configurations_by_using_puppet_integration/index#creating-a-puppet-config-group_managing-configurations-puppet",
'SmartMatchers' => "managing_configurations_by_using_puppet_integration/index#Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet",
'FactsandtheENC' => "managing_configurations_by_using_puppet_integration/index#high-level-steps-for-configuration-management-with-puppet",
'Parameters' => "managing_configurations_by_using_puppet_integration/index#Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet",
'Classes' => "managing_configurations_by_using_puppet_integration/index#Importing_Puppet_Classes_and_Environments_managing-configurations-puppet",
'Environments' => "managing_configurations_by_using_puppet_integration/index#Creating_a_Custom_Puppet_Environment_managing-configurations-puppet",

# Administering
'ConfigurationOptions' => "administering_red_hat_satellite/index",
Expand All @@ -46,8 +42,6 @@ module Documentation
'LDAPAuthentication' => "configuring_authentication_for_red_hat_satellite_users/index#configuring-an-ldap-server-as-an-external-identity-provider-for-project_authentication",
'ExternalAuthentication' => "configuring_authentication_for_red_hat_satellite_users/index",
'Bookmarks' => "administering_red_hat_satellite/index#Searching_and_Bookmarking_admin",
'Policydeploymentoptions' => "managing_security_compliance/index#compliance-policy-deployment-options_security-compliance",
'CreatingSCAPcontent' => "managing_security_compliance/index#Configuring_SCAP_Contents_security-compliance",

# Planning
'SmartProxies' => "overview_concepts_and_deployment_considerations/index#Major-Satellite-Components_planning",
Expand All @@ -62,8 +56,8 @@ module Documentation
# Managing Security Compliance
'Monitoring_Compliance_security-compliance' => "managing_security_compliance/index#Monitoring_Compliance_security-compliance",
'Managing_Compliance_Policies_security-compliance' => "managing_security_compliance/index#Managing_Compliance_Policies_security-compliance",
'Configuring_SCAP_Contents_security-compliance' => "managing_security_compliance/index#Configuring_SCAP_Contents_security-compliance",
'tailoring-xccdf-profiles_security-compliance' => "managing_security_compliance/index#tailoring-xccdf-profiles_security-compliance",
'Configuring_SCAP_Contents_security-compliance' => "managing_security_compliance/index#configuring-scap-contents-for-compliance-policies-in-satellite",
'tailoring-xccdf-profiles_security-compliance' => "managing_security_compliance/index#customizing-xccdf-profiles-with-tailoring-files",
'deploying-compliance-policies_security-compliance' => "managing_security_compliance/index#deploying-compliance-policies_security-compliance",
}.freeze

Expand All @@ -86,6 +80,12 @@ module Documentation
'Managing_Configurations_Ansible' => {
'Importing_Ansible_Roles_and_Variables_ansible' => "managing_configurations_by_using_ansible_integration/index#Importing_Ansible_Roles_and_Variables_ansible",
'Overriding_Ansible_Variables_in_foreman_ansible' => "managing_configurations_by_using_ansible_integration/index#Overriding_Ansible_Variables_in_satellite_ansible",
},
'Managing_Configurations_Puppet' => {
'Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet' => "managing_configurations_by_using_puppet_integration/index#Configuring_Puppet_Smart_Class_Parameters_managing-configurations-puppet",
'Creating_a_Custom_Puppet_Environment_managing-configurations-puppet' => "managing_configurations_by_using_puppet_integration/index#Creating_a_Custom_Puppet_Environment_managing-configurations-puppet",
'Importing_Puppet_Classes_and_Environments_managing-configurations-puppet' => "managing_configurations_by_using_puppet_integration/index#Importing_Puppet_Classes_and_Environments_managing-configurations-puppet",
'creating-a-puppet-config-group_managing-configurations-puppet' => "managing_configurations_by_using_puppet_integration/index#creating-a-puppet-config-group_managing-configurations-puppet",
}
}.freeze

Expand Down
89 changes: 44 additions & 45 deletions test/fixtures/toc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -162,6 +162,7 @@
],
"increasing-logging-levels-of-satellite-components": [
"increasing-the-logging-level-for-foreman",
"increasing-the-logging-level-for-red-hat-lightspeed-in-satellite",
"increasing-the-logging-level-for-hammer",
"increasing-the-logging-level-for-capsule",
"increasing-the-logging-level-for-candlepin",
Expand Down Expand Up @@ -307,9 +308,6 @@
],
"resetting-external-authentication-configuration-for-kerberos-sso": [

],
"resetting-external-authentication-configuration-for-kerberos-sso": [

]
},
"installing_capsule_server": {
Expand Down Expand Up @@ -460,6 +458,7 @@
"Overriding_Ansible_Variables_in_satellite_ansible",
"adding-rhel-system-roles_ansible",
"synchronizing-ansible-collections_ansible",
"consuming-content-from-an-ansible-collection-repository",
"customizing-ansible-configuration_ansible",
"using-ansible-vault-with-satellite_ansible"
],
Expand Down Expand Up @@ -529,19 +528,24 @@
"providing-feedback-on-red-hat-documentation_managing-configurations-puppet": [

],
"introducing-configuration-management-by-using-puppet": [
"configuration-management-with-puppet-in-satellite": [
"How_Puppet_Integrates_With_Project_managing-configurations-puppet",
"supported-puppet-versions-and-system-requirements_managing-configurations-puppet",
"Enabling_Puppet_Integration_managing-configurations-puppet",
"high-level-steps-for-puppet-integration-with-satellite",
"high-level-steps-for-configuration-management-with-puppet",
"supported-puppet-versions-and-system-requirements_managing-configurations-puppet"
],
"enabling-puppet-integration-with-satellite": [
"installing-puppet-server-on-satellite-server-and-capsule-servers",
"Installing_and_Configuring_Puppet_Agent_during_Host_Provisioning_managing-configurations-puppet",
"installing-and-configuring-puppet-agent-during-host-registration_managing-configurations-puppet",
"Installing_and_Configuring_Puppet_Agent_Manually_managing-configurations-puppet",
"performing-configuration-management_managing-configurations-puppet",
"Disabling_Puppet_Integration_managing-configurations-puppet"
"Installing_and_Configuring_Puppet_Agent_Manually_managing-configurations-puppet"
],
"disabling-puppet-integration-with-satellite": [

],
"managing-puppet-modules_managing-configurations-puppet": [
"installing_a_puppet_module_managing-configurations-puppet",
"updating-a-puppet-module"
"updating-a-puppet-module-on-your-satellite-server"
],
"importing_puppet_classes_and_environments_managing-configurations-puppet": [

Expand All @@ -567,10 +571,7 @@
],
"enforcing-puppet-configuration-on-hosts_managing-configurations-puppet": [
"running-puppet-once-using-ssh_managing-configurations-puppet",
"understanding-intervals-of-automatic-enforcement_managing-configurations-puppet",
"setting-the-puppet-agent-run-interval_managing-configurations-puppet",
"setting-the-global-out-of-sync-interval_managing-configurations-puppet",
"setting-the-puppet-out-of-sync-interval_managing-configurations-puppet",
"configuring-puppet-intervals-of-automatic-enforcement",
"overriding-out-of-sync-interval-for-a-host-group_managing-configurations-puppet",
"overriding-out-of-sync-interval-for-an-individual-host_managing-configurations-puppet"
],
Expand Down Expand Up @@ -711,8 +712,10 @@
"content-view-environments-overview",
"content-view-environment-categories",
"content-view-environment-ordering-and-priority",
"assigning-content-view-environments-to-hosts",
"assigning-content-view-environments-to-hosts-by-using-subscription-manager",
"assigning-content-view-environments-to-hosts-in-bulk",
"assigning-content-view-environments-to-a-host-by-using-web-ui",
"assigning-content-view-environments-to-a-host-by-using-cli",
"assigning-content-view-environments-to-a-host-by-using-subscription-manager",
"comparison-of-content-view-environments-and-composite-content-views"
],
"synchronizing_content_between_servers_content-management": [
Expand Down Expand Up @@ -747,7 +750,8 @@
"setting-the-service-level-by-using-cli",
"enabling-and-disabling-repositories-on-activation-key_content-management",
"multiple-activation-keys-and-content-view-environments",
"assigning-content-view-environments-to-activation-keys",
"assigning-content-view-environments-to-an-activation-key-by-using-web-ui",
"assigning-content-view-environments-to-an-activation-key-by-using-cli",
"removing-all-content-view-environments-from-an-activation-key"
],
"managing_errata_content-management": [
Expand Down Expand Up @@ -794,7 +798,8 @@
"importing-an-iso-image-by-using-cli"
],
"managing_ansible_content_content-management": [
"synchronizing-ansible-collections_content-management"
"synchronizing-ansible-collections_content-management",
"consuming-content-from-an-ansible-collection-repository"
],
"managing-custom-file-type-content": [
"creating-a-local-source-for-a-custom-file-type-repository",
Expand Down Expand Up @@ -901,7 +906,11 @@
"deploying-insights-client-on-registered-hosts_insights-in-satellite",
"examining-recommendations-for-hosts_insights-in-satellite",
"remediating-issues-based-on-red-hat-lightspeed-recommendations_insights-in-satellite",
"disabling-recommendations",
"enabling-recommendations",
"examining-vulnerability-of-hosts",
"disabling-vulnerability-analysis-on-hosts",
"enabling-vulnerability-analysis-on-hosts",
"exclusion-of-hosts-from-red-hat-lightspeed-analytics_insights-in-satellite"
],
"connecting-ai-applications-to-the-mcp-server-for-satellite": [
Expand Down Expand Up @@ -1026,26 +1035,17 @@
"enabling-openscap": [

],
"configuring-compliance-policy-deployment-methods_security-compliance": [
"compliance-policy-deployment-options_security-compliance",
"configuring-satellite-for-ansible-compliance-policy-deployment",
"configuring-satellite-for-puppet-compliance-policy-deployment"
],
"listing-available-scap-contents-using-web-ui": [

],
"listing-available-scap-contents-using-cli": [

],
"configuring_scap_contents_security-compliance": [
"configuring-scap-contents-for-compliance-policies-in-satellite": [
"listing-available-scap-contents-using-web-ui",
"listing-available-scap-contents-using-cli",
"Loading_the_Default_SCAP_Contents_security-compliance",
"getting-supported-scap-contents-for-rhel_security-compliance",
"uploading-additional-scap-content-using-web-ui",
"uploading-additional-scap-content-using-cli",
"tailoring-xccdf-profiles_security-compliance",
"Uploading_a_Tailoring_File_security-compliance"
"customizing-xccdf-profiles-with-tailoring-files"
],
"managing_compliance_policies_security-compliance": [
"configuring-compliance-policy-deployment-methods_security-compliance",
"Creating_a_Compliance_Policy_security-compliance",
"Viewing_a_Compliance_Policy_security-compliance",
"Editing_a_Compliance_Policy_security-compliance",
Expand All @@ -1067,8 +1067,7 @@
"Compliance_Email_Notifications_security-compliance",
"Viewing_Compliance_Policy_Statistics_security-compliance",
"remediating-compliance-failures_security-compliance",
"Deleting_a_Compliance_Report_security-compliance",
"Deleting_Multiple_Compliance_Reports_security-compliance"
"Deleting_a_Compliance_Report_security-compliance"
]
},
"monitoring_satellite_performance": {
Expand Down Expand Up @@ -1103,7 +1102,7 @@
"providing-feedback-on-red-hat-documentation_planning": [

],
"satellite-overview": [
"introduction-to-satellite": [

],
"content-and-patch-management-with-satellite": [
Expand Down Expand Up @@ -1178,9 +1177,9 @@
"iss-scenarios_planning",
"deploying-satellite-on-aws"
],
"provisioning-requirements": [
"pxe-booting",
"http-booting"
"provisioning-requirements-in-satellite": [
"pxe-booting-in-satellite",
"http-booting-in-satellite"
],
"technical-users-provided-and-required-by-satellite": [

Expand Down Expand Up @@ -1276,7 +1275,7 @@
"virt-who",
"XCCDF_profiles"
],
"cli-help_planning": [
"help-resources-for-using-cli-in-satellite": [
"Services",
"Plugins",
"Hammer_CLI"
Expand Down Expand Up @@ -1497,23 +1496,23 @@
"introduction_to_performance_tuning_performance-tuning": [

],
"performance-tuning-quick-start": [
"selecting-an-installation-size": [

],
"system_requirements_for_tuning_performance-tuning": [

],
"determining_hardware_and_operating_system_configuration_performance-tuning": [
"hardware-and-operating-system-configuration": [
"Enabling_Tuned_Profiles_performance-tuning",
"Disable_Transparent_Hugepage_performance-tuning"
],
"configuring_project_for_performance_performance-tuning": [
"Applying_configurations_performance-tuning",
"Puma_Tunings_performance-tuning",
"considerations-for-performance-tuning",
"puma-tunings",
"Apache_HTTPD_Performance_Tuning_performance-tuning",
"Dynflow_Tuning_performance-tuning",
"tuning-dynflow",
"Pull_based_REX_transport_tuning_performance-tuning",
"PostgreSQL_Tuning_performance-tuning",
"tuning-postgresql",
"Redis_Tuning_performance-tuning",
"Smart_Proxy_Configuration_Tuning_performance-tuning"
]
Expand Down