Skip to content

Commit 5fddab7

Browse files
Fix content readability issues for upgrading your project section (#4171)
* Fix content readability issues for upgrading your project section Shorten/split long sentences in the 'Upgrading your project' section of the connected upgrade guide. JIRA: https://issues.redhat.com/browse/SAT-35663
1 parent b8ec15d commit 5fddab7

File tree

3 files changed

+8
-5
lines changed

3 files changed

+8
-5
lines changed

guides/common/modules/proc_upgrading-your-project-server.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[id="upgrading-your-{project-context}-server"]
44
= Upgrading your {ProjectServer}
55

6-
Upgrading a {ProjectServer} with access to the public internet includes backing up the server, ensuring that the system and {Project} configuration is up-to-date, and running the upgrade.
6+
Upgrading a connected {ProjectServer} includes backing up the server, updating the system and {Project} configuration, and running the upgrade.
77

88
include::snip_warning-maintain-config-noop.adoc[]
99

guides/common/modules/snip_post-upgrade-tasks.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
. Perform the following post-upgrade tasks to ensure your environment is adjusted to any changes applied during the upgrade.
2-
.. If any of the templates you are using were created by cloning the default {Project} templates, verify whether the default templates changed during the upgrade.
3-
If the default templates have changed, consider updating your custom templates as well to reflect these changes.
2+
.. Verify whether the default templates changed during the upgrade.
3+
Update any custom templates that you created by cloning a default template to reflect these changes.
44
+
55
[NOTE]
66
====
7-
If the default provisioning templates changed during the upgrade and your custom code is executed before or after the provisioning process, you can use custom provisioning snippets to avoid recreating cloned templates.
7+
Use custom provisioning snippets to execute custom code before or after the provisioning process instead of cloning default templates.
8+
You can avoid recreating cloned templates if you use custom provisioning snippets.
89
For more information about configuring custom provisioning snippets, see {ProvisioningDocURL}running-custom-code-during-host-provisioning[Running custom code during host provisioning] in _{ProvisioningDocTitle}_.
910
====
1011
.. If your {Project} shows any discovered hosts, reboot them:

guides/common/modules/snip_warning-maintain-config-noop.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
[WARNING]
2-
If you customize configuration files, manually or using a tool such as Hiera, these changes are overwritten when the maintenance script runs during upgrading or updating.
2+
Note that the {foreman-installer} is executed during an upgrade or update.
3+
Any files managed by {foreman-installer} are overwritten.
4+
Check if you have any manual changes that would be overwritten by {foreman-installer}.
35
You can use the `--noop` option with the {foreman-installer} to test for changes.
46
ifdef::satellite[]
57
For more information, see the Red Hat Knowledgebase solution https://access.redhat.com/solutions/3351311[How to use the noop option to check for changes in {Project} config files during an upgrade.]

0 commit comments

Comments
 (0)