Changes between Version 11 and Version 12 of CookBook/About
- Timestamp:
- Feb 16, 2015, 8:25:44 PM (9 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
CookBook/About
v11 v12 1 1 [[PageOutline]] 2 = Trac Cookbook = 3 == Introduction == 4 Loads of information on how to accomplish particular tasks with Trac already exists in one form or another 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. 2 = Trac Cookbook 3 4 == Introduction 5 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. 5 7 6 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. … … 8 10 A "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. 9 11 10 == Sources for Recipes == 12 == Can I submit a recipe? 13 14 Sure, go ahead! However, make sure the recipe is valid, such as describing a successful deployment start to end. If you go halfway and get stuck somewhere, get help and feedback first, before writing up the recipe. See also InstallationIssue for what to do in this case. 15 16 == Sources for Recipes 11 17 12 18 The cookbook is open to both suggestions for recipes and the recipes themselves. … … 35 41 }}} 36 42 37 == Can I submit a recipe? ==38 39 Sure, go ahead! However, make sure the recipe is valid, such as describing a successful deployment start to end. If you go halfway and get stuck somewhere, get help and feedback first, before writing up the recipe. See also InstallationIssue for what to do in this case.40 41 43 ---- 42 44 See also: SeaChange/DocumentationRequests