Edgewall Software

Changes between Version 12 and Version 13 of CookBook/About


Ignore:
Timestamp:
Apr 5, 2015, 9:52:19 PM (9 years ago)
Author:
figaro
Comment:

Cosmetic changes

Legend:

Unmodified
Added
Removed
Modified

  • CookBook/About

    v12 v13  
    1 [[PageOutline]]
     1[[PageOutline(2-5,Contents,pullout)]]
     2
    23= Trac Cookbook
    34
    45== Introduction
    56
    6 Loads of information on how to accomplish particular tasks with Trac already exists in forum posts, blogs, third party web pages, and even the Trac documentation. However, this non-centralized information can sometimes be hard to find, especially if the "answer" is buried in forum threads. Often the prerequisites for the answer - conceptual, hardware or software - are missing. And after all, there is no guarantee that the solution will actually work.
    7 
    8 A good "recipe" will be '''a complete how-to''', so that one should be able to end up with the desired goal at the end of the steps, with all prerequisites and all intermediate steps. Ideally, the "why" for the steps is be included.
     7Loads of information on how to accomplish particular tasks with Trac already exists in forum posts, blogs, third party web pages, and even the Trac documentation. However, this non-centralized information can sometimes be hard to find, especially if the "answer" is buried in forum threads. Often the prerequisites for the answer - conceptual, hardware or software - are missing. And there is no guarantee that the solution will actually work.
    98
    109A "recipe" is a clear and reliable set of instructions that have a high probability of working under a broad range of conditions. Recipes should also be complete and self-contained.
     10
     11A good "recipe" will be '''a complete how-to''', so that one should be able to end up with the desired goal at the end of the steps, with all prerequisites and all intermediate steps. Ideally, the "why" for the steps should be included.
    1112
    1213== Can I submit a recipe?
    … …  
    4344----
    4445See also: SeaChange/DocumentationRequests
    45 
    46 {{{
    47 #!comment
    48 Author: Ariel Balter
    49 Email: ariel@arielbalter.com
    50 Date: 2009 June 3 14:05 PST
    51 
    52 Later edited by cboos, and others (see the History tab)
    53 }}}