You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The anchor #Troubleshooting_foreman no longer exists, but assuming this issue is about appendices Troubleshooting DNF modules and Troubleshooting sync errors:
Separating troubleshooting information from the rest of documentation is generally not a good idea. This is because troubleshooting steps are most useful when users see them right when they encounter the issue. For example, one of the troubleshooting steps in Troubleshooting sync errors reads:
"[Errno 1] Operation not permitted: …" during repository syncing
# chown --recursive pulp.pulp /var/lib/pulp/media/
This would be most effective when included within a procedure that describes syncing repositories, under a .Troubleshooting subheading as described in the mod docs guide.
After checking the current version of the mod docs guide, I can see that the guidance for including troubleshooting information has changed several months ago. The guide now seems to prefer creating separate troubleshooting modules although the wording is not entirely decisive.
The troubleshooting section (https://docs.theforeman.org/nightly/Installing_Server/index-katello.html#Troubleshooting_foreman) is currently tucked into the installation guide. It would probably be better to have a separate section of the documentation entirely for troubleshooting.
The text was updated successfully, but these errors were encountered: