Important: You are required to change your passwords used for Gentoo services and set an email address for your Wiki account if you haven't done so. See the full announcement and Wiki email policy change for more information.

Knowledge Base:Main Page

From Gentoo Wiki
Jump to: navigation, search

The Knowledge Base section in the Gentoo Wiki provides quick answers to questions and issues that might come up during any activity on a Gentoo Linux system.

By providing a knowledge base section, specific issues can be described (even when they hit a very small user base) and documented whereas more generic questions can be described in a small entry, referring to the various other resources that help the user further in his quest.

Structure

Each entry in the knowledge base is structured as follows:

Title Description
Synopsis More detail about the error or situation that the entry talks about. Users should be able to verify if the issue they have is described in this knowledge base entry by reading the synopsis.
Environment The environment describes when the knowledge base entry applies. For instance, when a problem occurs only when a certain kernel module is loaded, the environment should tell the user that he should check if that module is indeed loaded. In other words, it provides a way for users to "filter out" entries that do not match their system.
Analysis The analysis section describes why the issue occurred, telling the user what the essential flaw is that caused the error. It serves as an information section to the user to comprehend what went wrong.
Resolution The resolution section guides the user through the necessary steps to resolve the issue.
Further Resources Within this section, links to other entries or related material can be shown.

An entry should be specific enough so that the entry doesn't blow up with several dozen methods of resolving. When an entry is growing too large, it should be split into multiple entries.

Allowed entries

There is no reason why content would or wouldn't be allowed, as long as its structure is as described above and the entry is sufficiently specific so that no double entries exist that describe the same issue, nor that entries exist that span several dozen of issues and resolutions.

Searching the Knowledge Base

Go to the Advanced Search, type in your search terms in the search box, make sure Knowledge Base is selected and click search.

Further Resources