search

theforeman / foreman-documentation

Documentation for the Foreman Project and its ecosystem
https://docs.theforeman.org
Creative Commons Attribution Share Alike 4.0 International
22 stars 95 forks source link

Integrate 6.1 Troubleshooting into prov guide #45

Open lzap opened 5 years ago

lzap commented 5 years ago

Into provisioning guide from https://theforeman.org/plugins/foreman_discovery/15.0/index.html

melcorr commented 5 years ago

This may not happen in this format. We will have to uphold current documentation conventions of Red Hat. When I get through everything for this guide, I will look into this. An article might be best for this.

lzap commented 5 years ago

@ares actually brought this topic on our meeting today and we would like to be better in providing troubleshooting information and we agreed that the new documentation could be a new place for this. If this is a problem we can hide those sections from downstream, or even create a dedicated Troubleshooting Guide that would not be built downstream.

melcorr commented 5 years ago

The problem with Troubleshooting guides is that they very quickly become a dump of a thousand different things. Ideally the information is in the relevant sections of the doc so that the user doesn't need to troubleshoot. However, I know that is easier said than done. I will think about how best to approach this.

melcorr commented 5 years ago

Note to self: can we discuss "verification steps" in our next meeting.

ekohl commented 1 year ago

@Lennonka perhaps this is relevant in your process of reviewing the provisioning guide. If not, we can close it.

Lennonka commented 1 year ago

It isn't relevant in our current scope and I will not have the capacity to address this at least for half a year :(

Lennonka commented 1 year ago

However, it is relevant in the scope of moving the manual into the docs.

asteflova commented 1 year ago

@Lennonka Is this something I could perhaps help with? (Feel free to say no if it's something you'd like to do yourself when you have the capacity.)

Lennonka commented 1 year ago

@asteflova Yes, help would be great. :)

asteflova commented 8 months ago

For TW uni course students: Estimated effort -- L.

To be implemented as Troubleshooting sections based on Modular documentation guide.