Skip to content

Fix content readability issues for upgrading your project section #4171

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

Merged
merged 6 commits into from
Sep 16, 2025
Merged

Fix content readability issues for upgrading your project section #4171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
87514d1
Fix content readability issues for upgrading your project section
Aug 19, 2025
09ed989
Add statement about avoiding recreating template
Aug 19, 2025
60214db
Incorporate changes suggested in the PR
Aug 20, 2025
7743351
Reword and rectify outdated information
Sep 2, 2025
534ea0c
Apply changes suggested in the PR
Sep 9, 2025
be1cb58
Drop unnecessary comma
Sep 11, 2025
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
2 changes: 1 addition & 1 deletion guides/common/modules/proc_upgrading-your-project-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[id="upgrading-your-{project-context}-server"]
= Upgrading your {ProjectServer}

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.
Upgrading a connected {ProjectServer} includes backing up the server, updating the system and {Project} configuration, and running the upgrade.

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

Expand Down
7 changes: 4 additions & 3 deletions guides/common/modules/snip_post-upgrade-tasks.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
. Perform the following post-upgrade tasks to ensure your environment is adjusted to any changes applied during the upgrade.
.. 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.
If the default templates have changed, consider updating your custom templates as well to reflect these changes.
.. Verify whether the default templates changed during the upgrade.
Update any custom templates that you created by cloning a default template to reflect these changes.
+
[NOTE]
====
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.
Use custom provisioning snippets to execute custom code before or after the provisioning process instead of cloning default templates.
You can avoid recreating cloned templates if you use custom provisioning snippets.
For more information about configuring custom provisioning snippets, see {ProvisioningDocURL}running-custom-code-during-host-provisioning[Running custom code during host provisioning] in _{ProvisioningDocTitle}_.
====
.. If your {Project} shows any discovered hosts, reboot them:
Expand Down
4 changes: 3 additions & 1 deletion guides/common/modules/snip_warning-maintain-config-noop.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[WARNING]
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.
Note that the {foreman-installer} is executed during an upgrade or update.
Any files managed by {foreman-installer} are overwritten.
Check if you have any manual changes that would be overwritten by {foreman-installer}.
You can use the `--noop` option with the {foreman-installer} to test for changes.
ifdef::satellite[]
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.]
Expand Down