Skip to content

Commit

Permalink
Change headers to sentence case #4 (#2734)
Browse files Browse the repository at this point in the history
Changing module and assembly titles to sentence case in compliance with Contributing guidelines.

Signed-off-by: Avital Pinnick <apinnick@redhat.com>
(cherry picked from commit a061f7c)
  • Loading branch information
apinnick authored and maximiliankolb committed Feb 7, 2024
1 parent 7fe4100 commit 327db7d
Show file tree
Hide file tree
Showing 202 changed files with 212 additions and 216 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ In such case, you can manage the versions downstream.
For more information, see xref:Using_Upstream_Server_as_a_Content_Store_{context}[].
* You use the upstream {ProjectServer} to sync Content View versions.
This approach offers more control over what content is synced between {ProjectServer}s.
For more information, see xref:Using_Upstream_Server_to_Sync_Content_View_Versions_{context}[].
For more information, see xref:Using_Upstream_Server_to_Synchronize_Content_View_Versions_{context}[].
* You sync a single repository.
This can be useful if you use the Content-View syncing approach, but you want to sync an additional repository without adding it to an existing Content View.
For more information, see xref:synchronizing-a-single-repository_{context}[].
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ endif::[]
ifndef::foreman-deb[]
* xref:migrating-ansible-content_{context}[]
endif::[]
* xref:reclaiming-postgresql-space-after-an-upgrade_{context}[]
* xref:reclaiming-postgresql-space_{context}[]
ifndef::foreman-el,foreman-deb[]
* xref:tuning-with-predefined-profiles_{context}[]
endif::[]
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Managing_and_Monitoring_Hosts_Using_Cockpit_{context}"]
= Managing and Monitoring Hosts Using {CockpitTitle}
= Managing and monitoring hosts using {CockpitTitle}

You can access the {Cockpit} web UI through the {ProjectWebUI} and use the functionality to manage and monitor hosts in {Project}.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Managing_Container_Name_Patterns_{context}"]
= Managing Container Name Patterns
= Managing container name patterns

When you use {Project} to create and manage your containers, as the container moves through Content View versions and different stages of the {Project} lifecycle environment, the container name changes at each stage.
For example, if you synchronize a container image with the name `ssh` from an upstream repository, when you add it to a {Project} product and organization and then publish as part of a Content View, the container image can have the following name: `my_organization_production-custom_spin-my_product-custom_ssh`.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Managing_Container_Registry_Authentication_{context}"]
= Managing Container Registry Authentication
= Managing container registry authentication

You can manage the authentication settings for accessing containers images from {Project}.
By default, users must authenticate to access containers images in {Project}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="managing-ostree-content-with-content-views_{context}"]
= Managing OSTree Content with Content Views
= Managing OSTree content with Content Views

Use Content Views to manage OSTree branches across the application lifecycle.
This process uses the same publication and promotion method as RPMs or Puppet modules.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Managing_Packages_on_the_Base_Operating_System_{context}"]
= Managing Packages on the Base Operating System of {ProjectServer} or {SmartProxyServerTitle}
= Managing packages on the base operating system of {ProjectServer} or {SmartProxyServerTitle}

To install and update packages on the {ProjectServer} or {SmartProxyServer} base operating system, you must enter the `{foreman-maintain} packages` command.
{Project} prevents users from installing and updating packages with `yum` because `yum` might also update the packages related to {ProjectServer} or {SmartProxyServer} and result in system inconsistency.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="puppet_guide_managing_puppet_modules_with_r10k_{context}"]
= Managing Puppet Modules with r10k
= Managing Puppet modules with r10k

You can manage Puppet modules and environments using https://github.com/puppetlabs/r10k[r10k].
r10k uses a list of Puppet roles from a `Puppetfile` to download Puppet modules from the Puppet Forge or git repositories.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Managing_SSH_Keys_for_a_User_{context}"]
= Managing SSH Keys for a User
= Managing SSH keys for a user

Use this procedure to add or remove SSH keys for a user.
To use the CLI instead of the {ProjectWebUI}, see the xref:cli-managing-ssh-keys-for-a-user_{context}[].
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_managing-tasks.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Managing_Tasks_{context}"]
= Managing Tasks
= Managing tasks

{ProjectName} keeps a complete log of all planned or performed tasks, such as repositories synchronised, errata applied, and Content Views published.
To review the log, navigate to *Monitor* > *{Project} Tasks* > *Tasks*.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Managing_the_Lifecycle_of_the_Content_View_{context}"]
= Managing the Lifecycle of the Content View
= Managing the lifecycle of the Content View

The default location of any new Content View is in the Library Environment.
Optionally, you can add a new environment and promote your Content View to it.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Migration_a_Host_From_One_Server_to_another_Server_{context}"]
= Migrating a Host From One {Project} to Another {Project}
= Migrating a host from one {Project} to another {Project}

Use the script with `--force` to remove the `katello-ca-consumer-{asterisk}` packages from the old {Project} and install the `katello-ca-consumer-{asterisk}` packages on the new {Project}.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Migrating_a_Host_from_Red_Hat_Network_{context}"]
= Migrating a Host from Red Hat Network (RHN) or Satellite 5 to {Project}
= Migrating a host from Red Hat Network (RHN) or Satellite 5 to {Project}

The bootstrap script detects the presence of `/etc/syconfig/rhn/systemid` and a valid connection to RHN as an indicator that the system is registered to a legacy platform.
The script then calls `rhn-classic-migrate-to-rhsm` to migrate the system from RHN.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="migrating-to-external-databases_{context}"]
= Migrating to External Databases
= Migrating to external databases

Back up and transfer existing data, then use the `{foreman-installer}` command to configure {Project} to connect to an external PostgreSQL database server.

Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_monitoring-remote-jobs.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Monitoring_Jobs_{context}"]
= Monitoring Jobs
= Monitoring jobs

You can monitor the progress of a job while it is running.
This can help in any troubleshooting that may be required.
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_monitoring-services.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Monitoring_Services_{context}"]
= Monitoring Services
= Monitoring services

In the {ProjectWebUI}, navigate to *Infrastructure* > *{SmartProxies}* and click the name of the selected {SmartProxy}.
At the *Services* tab, you can find basic information on {SmartProxy} services, such as the list of DNS domains, or the number of Pulp workers.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Overriding_Smart_Class_Parameter_for_Location_{context}"]
= Overriding a Smart Class Parameter for a Location
= Overriding a smart class parameter for a location

You can use groups of hosts to override Puppet parameters for multiple hosts at once.
The following examples chooses the _location_ context to illustrate setting context based parameters.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Overriding_Smart_Class_Parameter_for_Organization_{context}"]
= Overriding a Smart Class Parameter for an Organization
= Overriding a smart class parameter for an organization

You can use groups of hosts to override Puppet parameters for multiple hosts at once.
The following example chooses the _organization_ context to illustrate setting context based parameters.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Overriding_Smart_Class_Parameter_Globally_{context}"]
= Overriding a Smart Class Parameter Globally
= Overriding a smart class parameter globally

You can configure a Puppet class after you have imported it to {ProjectServer}.
This example overrides the default list of ntp servers.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Overriding_Smart_Class_Parameter_Individual_Host_{context}"]
= Overriding a Smart Class Parameter on an Individual Host
= Overriding a smart class parameter on an individual host

You can override parameters on individual hosts.
This is recommended if you have multiple hosts and only want to make changes to a single one.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Overriding_Ansible_Variables_in_{project-context}_{context}"]
= Overriding Ansible Variables in {Project}
= Overriding Ansible variables in {Project}

If you run Ansible roles in {Project}, you can use {Project} to override Ansible variables for those roles.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="overriding-out-of-sync-interval-for-a-host-group_{context}"]
= Overriding Out-of-Sync Interval for a Host Group
= Overriding out-of-sync interval for a host group

.Procedure
. In the {ProjectWebUI}, navigate to *Configure > Host Groups*.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="overriding-out-of-sync-interval-for-an-individual-host_{context}"]
= Overriding Out-of-Sync Interval for an Individual Host
= Overriding out-of-sync interval for an individual host

.Procedure
. In the {ProjectWebUI}, navigate to *Hosts > All Hosts*.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Overwriting_Ansible_Group_Variables_in_Application_Instances_{context}"]
= Overwriting Ansible Group Variables in Application Instances
= Overwriting Ansible group variables in application instances

You can overwrite Ansible group variables in application instances unless the parameters are locked by the application definition.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="passing-arguments-to-shellhook-script-using-curl_{context}"]
= Passing Arguments to Shellhook Script Using Curl
= Passing arguments to shellhook script using curl

Use this procedure to pass arguments to a shellhook script using curl.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="passing-arguments-to-shellhook-script-using-webhooks_{context}"]
= Passing Arguments to Shellhook Script Using Webhooks
= Passing arguments to shellhook script using webhooks

Use this procedure to pass arguments to a shellhook script using webhooks.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Performing_a_Backup_Without_Pulp_Content_{context}"]
= Performing a Backup without Pulp Content
= Performing a backup without Pulp content

You can perform an offline backup that excludes the contents of the Pulp directory.
The backup without Pulp content is useful for debugging purposes and is only intended to provide access to configuration files without backing up the Pulp database.
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_performing-a-full-backup.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Performing_a_Full_Backup_{context}"]
= Performing a Full Backup of {ProjectServer} or {SmartProxyServerTitle}
= Performing a full backup of {ProjectServer} or {SmartProxyServerTitle}

{ProjectName} uses the `{foreman-maintain} backup` command to make backups.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Performing_a_Snapshot_Backup_{context}"]
= Performing a Snapshot Backup
= Performing a snapshot backup

You can perform a snapshot backup that uses Logical Volume Manager (LVM) snapshots of the Pulp, and PostgreSQL directories.
Creating a backup from LVM snapshots mitigates the risk of an inconsistent backup.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Performing_an_Incremental_Backup_{context}"]
= Performing an Incremental Backup
= Performing an incremental backup

Use this procedure to perform an offline backup of any changes since a previous backup.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Performing_an_Online_Backup_{context}"]
= Performing an Online Backup
= Performing an online backup

Perform an online backup only for debugging purposes.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="preparing-a-cloud-init-template_{context}"]
= Preparing a Cloud-init Template
= Preparing a cloud-init template

ifdef::foreman-el,katello[]
.Prerequisites
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="preparing-a-host-for-external-databases_{context}"]
= Preparing a Host for External Databases
= Preparing a host for external databases

Install a freshly provisioned system with the latest {EL} 8 to host the external databases.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="preparing-cloud-init-images-in-rhv_{context}"]
= Preparing Cloud-init Images in {oVirt}
= Preparing cloud-init images in {oVirt}

To use `cloud-init` during provisioning, you must prepare an image with `cloud-init` installed in {oVirt}, and then import the image to {Project} to use for provisioning.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Preparing_SUSE_Installation_Media_{context}"]
= Preparing SUSE Installation Media
= Preparing SUSE installation media

Use this procedure to extract the SUSE installation medium on your {ProjectServer} to provision hosts in a disconnected environment.
This example prepares the installation medium for SUSE Linux Enterprise Server 15 SP3.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Promoting_your_Content_View_to_the_New_Lifecycle_Environment_{context}"]
= Promoting your Content View to the New Lifecycle Environment
= Promoting your Content View to the new lifecycle environment

You can now promote your new Content View to the *Production* environment using the following procedure.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Propagating_SCAP_Content_using_Ansible_Deployment_{context}"]
= Propagating SCAP Content using Ansible Deployment
= Propagating SCAP content using Ansible deployment

Using this procedure, you can promote Security Content Automation Protocol (SCAP) content through the load balancer in the scope of the Ansible deployment method.

Expand All @@ -21,7 +21,7 @@ For more information, see {ManagingSecurityDocURL}configuring-compliance-policy-
. In the *Default Value* field, enter the FQDN of your load balancer, such as `_{loadbalancer-example-com}_`.
. In the *Specify Matchers* area, remove all matchers that override the default value.
. Click *Submit*.
. Continue with deploying a compliance policy using Ansible.
. Continue with deploying a compliance policy using Ansible.
For more information, see:
* {ManagingSecurityDocURL}Deploying_a_Policy_in_a_Host_Group_Using_Ansible_security-compliance[Deploying a Policy in a Host Group Using Ansible] in _{ManagingSecurityDocTitle}_
* {ManagingSecurityDocURL}Deploying_a_Policy_on_a_Host_Using_Ansible_security-compliance[Deploying a Policy on a Host Using Ansible] in _{ManagingSecurityDocTitle}_
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Propagating_SCAP_Content_using_Puppet_Deployment_{context}"]
= Propagating SCAP Content using Puppet Deployment
= Propagating SCAP content using Puppet deployment

Using this procedure, you can promote Security Content Automation Protocol (SCAP) content through the load balancer in the scope of the Puppet deployment method.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Providing_an_Alternative_FQDN_for_the_Host_{context}"]
= Providing an Alternative FQDN for the Host
= Providing an alternative FQDN for the host

If the host's host name is not an FQDN, or is not RFC-compliant (containing a character such as an underscore), the script will fail at the host name validation stage.
If you cannot update the host to use an FQDN that is accepted by {Project}, you can use the bootstrap script to specify an alternative FQDN.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[preface]

[id="providing-feedback-on-red-hat-documentation_{context}"]
= Providing Feedback on Red Hat Documentation
= Providing feedback on Red Hat documentation

We appreciate your input on our documentation.
Please let us know how we could make it better.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Provisioning_Ubuntu_Autoinstall_Through_Smart_Proxies_{context}"]
= Provisioning Ubuntu Autoinstall Through {SmartProxies}
= Provisioning Ubuntu autoinstall through {SmartProxies}

Perform these steps to provision hosts running Ubuntu 20.04.3+ or Ubuntu 22.04.

Expand Down
4 changes: 2 additions & 2 deletions guides/common/modules/proc_reclaiming-postgresql-space.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="reclaiming-postgresql-space-after-an-upgrade_{context}"]
= Reclaiming PostgreSQL Space
[id="reclaiming-postgresql-space_{context}"]
= Reclaiming PostgreSQL space

The PostgreSQL database can use a large amount of disk space especially in heavily loaded deployments.
Use this procedure to reclaim some of this disk space on {Project}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="reclaiming-space-from-on-demand-repositories_{context}"]
= Reclaiming Space From On Demand Repositories
= Reclaiming space from on demand repositories

If you set the _download policy_ to on demand, {Project} downloads packages only when the clients request them.
You can clean up these packages to reclaim space.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Recovering_a_Corrupted_Repository_{context}"]
= Recovering a Corrupted Repository
= Recovering a corrupted repository

In case of repository corruption, you can recover it by using an advanced synchronization, which has three options:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Recovering_from_a_Full_Disk_{context}"]
= Recovering from a Full Disk
= Recovering from a full disk

The following procedure describes how to resolve the situation when a logical volume (LV) with the Pulp database on it has no free space.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Refreshing_Content_Counts_on_{smart-proxy-context-titlecase}_{context}"]
= Refreshing Content Counts on {SmartProxy}
= Refreshing content counts on {SmartProxy}

If your {SmartProxies} have synchronized content enabled, you can refresh the number of content counts available to the environments associated with the {SmartProxy}.
This displays the Content Views inside those environments available to the {SmartProxy}.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Refreshing_External_User_Groups_for_LDAP_{context}"]
= Refreshing External User Groups for LDAP
= Refreshing external user groups for LDAP

To set the LDAP source to synchronize user group membership automatically on user login, in the *Auth Source* page, select the *Usergroup Sync* option.
If this option is not selected, LDAP user groups are refreshed automatically through a scheduled cron job synchronizing the LDAP Authentication source every 30 minutes by default.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Refreshing_the_Compute_Resources_Cache_{context}"]
= Refreshing the Compute Resources Cache
= Refreshing the compute resources cache

Refresh the cache of compute resources to update compute resources information.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Registering_a_Host_for_Content_Management_Only_{context}"]
= Registering a Host to {Project} for Content Management Only
= Registering a host to {Project} for content management only

To register a system as a content host, and omit the provisioning and configuration management functions, use `--skip-foreman`.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Registering_a_Host_Without_Puppet_{context}"]
= Registering a Host to {Project} without Puppet
= Registering a host to {Project} without Puppet

By default, the bootstrap script configures the host for content management and configuration management.
If you have an existing configuration management system and do not want to install Puppet on the host, use `--skip-puppet`.
Expand Down
2 changes: 1 addition & 1 deletion guides/common/modules/proc_registering-a-host.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="registering-a-host_{context}"]
= Registering a Host
= Registering a host

You can register a host by using registration templates and set up various integration features and host tools during the registration process.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
ifdef::orcharhino,satellite[]
[id="Registering_Clients_Using_Host_Registration_{context}"]
= Registering Clients Using Host Registration
= Registering clients using host registration
endif::[]

include::snip_host-registration-steps.adoc[]
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Registering_Clients_Using_the_Bootstrap_Script_{context}"]
= **(Deprecated)** Registering Clients Using the Bootstrap Script
= **(Deprecated)** Registering clients using the bootstrap script

To register clients, enter the following command on the client.
You must complete the registration procedure for each client.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[id="Registering_Hosts_by_Using_the_Bootstrap_Script_{context}"]
= Registering Hosts by Using The Bootstrap Script
= Registering hosts by using the bootstrap script

**Deprecated** Use xref:Registering_Hosts_by_Using_Global_Registration_{context}[] instead.

Expand Down
Loading

0 comments on commit 327db7d

Please sign in to comment.