Coder Social home page Coder Social logo

Comments (10)

Lennonka avatar Lennonka commented on July 18, 2024 1

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

from foreman-documentation.

melcorr avatar melcorr commented on July 18, 2024

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.

from foreman-documentation.

lzap avatar lzap commented on July 18, 2024

@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.

from foreman-documentation.

melcorr avatar melcorr commented on July 18, 2024

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.

from foreman-documentation.

melcorr avatar melcorr commented on July 18, 2024

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

from foreman-documentation.

ekohl avatar ekohl commented on July 18, 2024

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

from foreman-documentation.

Lennonka avatar Lennonka commented on July 18, 2024

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

from foreman-documentation.

asteflova avatar asteflova commented on July 18, 2024

@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.)

from foreman-documentation.

Lennonka avatar Lennonka commented on July 18, 2024

@asteflova Yes, help would be great. :)

from foreman-documentation.

asteflova avatar asteflova commented on July 18, 2024

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

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

from foreman-documentation.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.