FAQEdit

Differences between revisions 2 and 3
⇤ ← Revision 2 as of 2010-07-01 08:57:50 →
Size: 1099
Editor: 85-210-153-201
Comment:
← Revision 3 as of 2010-07-01 09:11:43 → ⇥
Size: 1443
Editor: 85-210-153-201
Comment:
Deletions are marked like this. Additions are marked like this.
Line 9: Line 9:
When you make a new question create a new page in {{{Kernel/FAQ/<section><shortname>}}}. So for example a question about the mainline builds and how they could be used for debugging might be named {{{Kernel/FAQ/DebuggingMainlineBuilds}}}. You should use {{{<section>000<shortname>}}} for questions which belong at the top of a section. Some questions are also directly linked to and those linkages should be recorded below. == Page Naming ==

When you make a new question create a new page in {{{Kernel/FAQ/<section><shortname>}}}. So for example a question about the mainline builds and how they could be used for debugging might be named {{{Kernel/FAQ/DebuggingMainlineBuilds}}}. You should use {{{<section>000<shortname>}}} for questions which belong at the top of a section.

== Page Format ==

Each question should contain a level two {{{== ...? ==}}} heading which is formed as a simply worded question. The overall contents should be limited to a paragraph, perhaps two, if the contents is more complex it probabally warrents its own page which should have a simple pointer in the FAQ.
Line 12: Line 18:

Some questions are also directly linked to and those linkages should be recorded below.

Each question in the FAQ is its own wiki page. This allows us to use the wiki page aggregation operations to automatically generate the various section FAQs and the top level FAQ from the exact same question source. Each question should be categorised into one of the five main sections:

  • Help -- prominant questions on how to get help from somewhere
  • General -- general questions which do not have a specific section
  • Debugging -- questions pertinant to debugging kernel issues
  • Triage -- questions about triaging kernel bugs
  • Dev -- all developer related questions

Page Naming

When you make a new question create a new page in Kernel/FAQ/<section><shortname>. So for example a question about the mainline builds and how they could be used for debugging might be named Kernel/FAQ/DebuggingMainlineBuilds. You should use <section>000<shortname> for questions which belong at the top of a section.

Page Format

Each question should contain a level two == ...? == heading which is formed as a simply worded question. The overall contents should be limited to a paragraph, perhaps two, if the contents is more complex it probabally warrents its own page which should have a simple pointer in the FAQ.

Linkages

Some questions are also directly linked to and those linkages should be recorded below.

TBC

Existing Questions

  1. Kernel/FAQ/Debugging000Resources
  2. Kernel/FAQ/DebuggingMainlineBuildsSeries
  3. Kernel/FAQ/DebuggingMainlineBuildsSupport
  4. Kernel/FAQ/DebuggingMainlineBuildsUbuntuDrivers
  5. Kernel/FAQ/DevBuildMrProper
  6. Kernel/FAQ/DevDeveloperResources
  7. Kernel/FAQ/DevFlavours000WhatIs
  8. Kernel/FAQ/DevFlavoursHow
  9. Kernel/FAQ/DevFlavoursTransitions
  10. Kernel/FAQ/DevFlavoursWhere
  11. Kernel/FAQ/DevHowToPatch
  12. Kernel/FAQ/DevHugePackages
  13. Kernel/FAQ/DevKernelBugs
  14. Kernel/FAQ/DevKernelSource
  15. Kernel/FAQ/DevMetaPkgs
  16. Kernel/FAQ/DevTopicBranches
  17. Kernel/FAQ/DevUsingGit
  18. Kernel/FAQ/DevWhyNoFeatureX
  19. Kernel/FAQ/DevWhyNoPatchX
  20. Kernel/FAQ/GeneralFindingDocumentation
  21. Kernel/FAQ/GeneralFindingTeam
  22. Kernel/FAQ/GeneralGettingInvolved
  23. Kernel/FAQ/GeneralHandbooks
  24. Kernel/FAQ/GeneralHelpWith
  25. Kernel/FAQ/GeneralHowIsABugsSeriesDetermined
  26. Kernel/FAQ/GeneralHowToFileABug
  27. Kernel/FAQ/GeneralMailingList
  28. Kernel/FAQ/GeneralPatchFixCommitted
  29. Kernel/FAQ/GeneralPatchHandling
  30. Kernel/FAQ/GeneralUbuntuDelta
  31. Kernel/FAQ/GeneralVersionMeaning
  32. Kernel/FAQ/GeneralVersionRunning
  33. Kernel/FAQ/GeneralVersionToMainline
  34. Kernel/FAQ/GeneralVersionToRelease
  35. Kernel/FAQ/GeneralWeeklyMeetings
  36. Kernel/FAQ/GeneralWhyBugMarkedWontFix
  37. Kernel/FAQ/HelpDebuggingScenarios
  38. Kernel/FAQ/HelpKernel
  39. Kernel/FAQ/HelpUbuntu
  40. Kernel/FAQ/KernelFlavourDifferences
  41. Kernel/FAQ/MaintainerUploadAnnouncements
  42. Kernel/FAQ/TestingCallsForTesting
  43. Kernel/FAQ/Triage000WhatIsTriage
  44. Kernel/FAQ/TriageTriageLevels
  45. Kernel/FAQ/TriageTriageResources
  46. Kernel/FAQ/TweekKernelBootParameters
  47. Kernel/FAQ/UbuntuDelta

Kernel/FAQEdit (last edited 2011-01-27 09:18:10 by 212-139-222-124)