Differences between revisions 8 and 9
Revision 8 as of 2007-06-02 11:02:30
Size: 6414
Editor: FranklinPiat
Comment: Add "adverising your howto"
Revision 9 as of 2007-06-02 23:46:53
Size: 7030
Editor: FranklinPiat
Comment: add a "Howto Add/Edit a Page Fragment" section + rephrase.
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
#pragma description Help page for Debian On contributors
Line 13: Line 14:
= HowTo Add/Edit =
''Coding Style (!!) :''
= Coding Style =
''Coding Style...'' Ok, it isn't about coding, but it is about ''style''...
Line 17: Line 18:
  * There is a synergy for content stored on this wiki is: 1. It's editable by the community and 2. It's reusable (include..).
Line 22: Line 23:
 * '''Read the Comments''': when you ''edit'' some Installing_Debian_On* pages, there are lots of hints.  * '''Follow the direction''': when you ''edit'' some Installing_Debian_On* pages, there are lots of indications in the page comments (line begining with ##)
Line 32: Line 33:
 * '''Device Status''' : If you haven't tested a feature, simply write it ! (''Not Tested''). If you couldn't get a feature to work, write it ! (''Work Needed''). If your confident there's no driver, write it (''No driver in Etch'', or ''Not yes supported by  upstream driver as of 2006/12/31 (see ht``tp://URL/)''), etc..  * '''Device Status''' : If you haven't tested a feature, simply write it ! (''Not Tested''). If you couldn't get a feature to work, write it ! (''Work Needed''). If your confident there's no driver, write it (''No driver in Etch'', or ''Not yes supported by upstream driver as of 2006/12/31 (see ht``tp://somewhere/)''), etc..
Line 38: Line 39:
== Howto Add/Edit a Page Fragment ==
''Work in progress ;) ''
 * Use Template
 * Name it like: Page_Fragment_Devicename(Distribution) like Page_Fragment_Intel_ipw3945(Etch)
 * Try to guess how often that page fragment:
  * Is it specific to a computer brand ? or usable for many computer brands ? (this will determine the parent page).
 * Is it worth creating a discussion page ?
 * If it is very generic, maybe it should just a regular page (with a very tiny page fragment... For instance, how to transfer a file over bluetooth is outside of the scope of !DebianOn)

["?DebianWikiTopics"] > [:Installing_Debian_On/FrontPage:DebianOn] > HowToContribute

This page provide some guidelines on how to add/edit/contribute to the DebianOn effort.

DebianOn Philosophy

inline:Installing_Debian_On/FrontPage/DebianOn_?CommunityGuides.png

?Include(Installing_Debian_On/PageFragments/Philosophy)

Coding Style

Coding Style... Ok, it isn't about coding, but it is about style...

  • Re-use existing page fragment. MoinMoin wiki let you include a page in another page. So for instance, if the Dell Latitude D620 uses the same wireless card as the Thinkpad T60, you could put that section in a page named Installing_Debian_On/!?PageFragment_Intel_ipw3945, then include it from both the T60 and the D620 using:  [[Include(Installing_Debian_On/PageFragment_Intel_ipw3945)]]  ?BR Note that "PageFragment_Intel_ipw3945" is directly under "Installing_Debian_On", because it is very common.?BR If later it happen that the Dell Latitude have some specific configuration steps, it would be possible to copy "Installing_Debian_On/!?PageFragment_Intel_ipw3945" to "Installing_Debian_!OnDellLatitude/!?PageFragment_Intel_ipw3945".

  • Don't over-use links

    • Pages overloaded with links are less readable (Ideally, the reader just have to follow the recipe from top to bottom).
    • Many links can be moved to the resources section.
    • Do give credits to authors (in the credits section !). Preferably with name, URL and purpose.
    • Use ! in front of !WikiNames to avoid automatic linking.

  • Follow the direction: when you edit some Installing_Debian_On* pages, there are lots of indications in the page comments (line begining with ##)

  • Subscribe : You are encouraged to subscribe to the Installing_Debian_On page(s) for the configuration you have (For instance, subscribe to Installing_Debian/Dell/Latitude_D620.*). The ".*" is meant to catch "/Discussion" pages. (?UserPreferences).?BRYou will be pleased if someday someone fixes a problem... and you get noticed by email ! (and vice versa)

HowTo Add/Edit a Specific Computer Model

This section give advice to add or edit a computer model (like Thinkpad T61)

  • Quick : It's better to fill a quick, incomplete report (and still accurate), than no report at all.

  • Name of the page : In order to be consistent, the page should be name something like Installing_Debian_On/Mycomputerbrand/Mycomputermodel. So it is clearly affiliated to Installing_Debian_On/Mycomputerbrand.

  • Template : If a template named like "Installing_Debian_On/Mycomputerbrand_Template" exists, you should use it. Otherwise, use "Installing_Debian_On/!?GenericComputer_Template" or "Installing_Debian_On/!?GenericLaptop_Template" or "Installing_Debian_On/!?GenericServer_Template"

  • Debian/Stable (?) : If you don't use a fresh Debian Stable version, write it in your report.

  • Device Status : If you haven't tested a feature, simply write it ! (Not Tested). If you couldn't get a feature to work, write it ! (Work Needed). If your confident there's no driver, write it (No driver in Etch, or Not yes supported by upstream driver as of 2006/12/31 (see http://somewhere/)), etc..

  • Installation and Bug Reports : Open [http://www.debian.org/releases/stable/i386/release-notes/ch-moreinfo.html#s-bugs bugs] and make an [http://www.debian.org/releases/stable/i386/apas04.html installation-report] when needed. It isn't a duplicate work : bug report (including installation-report) are useful to to developers to prepare the next version/release of Debian. Whereas a "DebianOn Installation Howto's" helps end-users of current Debian version. (You can still cross-link the bug and wiki pages).

  • Advertise the new howto : This is especially useful if this computer is part of a new product line, and the Installation Howto is quite complete.

    • for laptop, send a mail to ?MailTo(debian DASH laptop AT lists DOT debian DOT org?subject= SPAM Installing%20Debian%20On [model], debian-laptop mainling list)

    • If this a new product line AND it is well supported by Debian/Stable, you could advertise on the FrontPage (post it on FrontPageNewsFeed)

Howto Add/Edit a Page Fragment

Work in progress ;)

  • Use Template
  • Name it like: Page_Fragment_Devicename(Distribution) like Page_Fragment_Intel_ipw3945(Etch)
  • Try to guess how often that page fragment:
    • Is it specific to a computer brand ? or usable for many computer brands ? (this will determine the parent page).
  • Is it worth creating a discussion page ?
  • If it is very generic, maybe it should just a regular page (with a very tiny page fragment... For instance, how to transfer a file over bluetooth is outside of the scope of DebianOn)

HowTo Add/Edit a Brand or Device Type

This section covers steps to add a new computer Brand (like Toshiba) or a new generic kind of devices (Watch running Linux, may be).

  • PageName : Think twice of the name of your hub : Installing_Debian_On/Dell, Installing_Debian_On/Dell_Latitude, Installing_Debian_On/Dell_Laptop/, Installing_Debian_On/Dell_Laptop/Latitude+Installing_Debian_On/Dell_Laptop/Inspiron etc.. (I would choose Installing_Debian_On/IBM/Thinkpad because it's the only names for their laptop, but I would choose Installing_Debian_On/Asus/Laptop because there are many laptop models).

  • Template : Create the page based on template Installing_Debian_On/Laptop_template

  • Page Alias : It might be a good idea to create a dummy wiki page named just "Mycomputerbrand" and link it to Installing_Debian_On/Mycomputerbrand, therefore : 1.user searching for that brand would find it easily. 2. Nobody will create a clone page by mistake. That dummy page should just contain :  #REDIRECT Installing_Debian_On/Mycomputerbrand 

FAQ

  • Who can contribute under Installing_Debian_On : Anybody, that's the purpose of a wiki !

  • What to contribute under Installing_Debian_On : Any return of experience in installing Debian on specific hardware. Again, Installing_Debian_On is not about how to use [:DebianInstaller:Debian Installer], neither is it a how to use some piece of software (but you are encourage contribute and link to such page).

  • Where to contribute : All Installing_Debian_On page are store on the Debian Wiki http://wiki.debian.org/Installing_Debian_On*.

  • When : Now or tomorrow (yesterday is just fine too). but 4 lines now are better than 2 pages never.

  • How : If the explanations at the top of this page aren't clear enough, Just AskTM in ["Installing_Debian_On/Discussion"].