Skip to content
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.

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

Docs: Improve OS installation debugging sections #3672

Open
SchoolGuy opened this issue Apr 4, 2024 · 1 comment
Open

Docs: Improve OS installation debugging sections #3672

SchoolGuy opened this issue Apr 4, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@SchoolGuy
Copy link
Member

Is your feature request related to a problem?

As a user of Cobbler
I want to have it easier to identify issues during installations via Cobbler
so that I can spend less time debugging issues.

Provide a detailed description of the proposed feature

To enhance the user experience two things should be added to the documentation:

  1. Add on the landing page a note that clarifies what content goes where. This should be done similar to what we have on the landing page of the GitHub Wiki.
  2. Add a note - where appropriate - to our Documentation that says that it is helpful for debugging purposes to use serial consoles or BMCs to record the screen. Some information during the boot process is only visible for mere seconds and might even be overlooked by personnel that is experienced with installing OSes on different hardware. (An example would be messages from the firmware on the screen, those will be only visible for a second until the next boot entry is attempted.)

Alternatives you've considered

None

Additional information

This was requested in a Jitsi meeting that I had with community members that was organized via our Matrix/Gitter chat.

@SchoolGuy SchoolGuy added enhancement New feature or request documentation Improvements or additions to documentation labels Apr 4, 2024
@SchoolGuy SchoolGuy added this to the v3.4.0 milestone Apr 4, 2024
@SchoolGuy
Copy link
Member Author

@tiltingpenguin could you try and take care of this in the coming weeks maybe?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Todo
Development

No branches or pull requests

2 participants