Changes between Version 4 and Version 5 of CookBook/About

Timestamp:

Jun 17, 2009, 10:59:17 AM (15 years ago)

Author:

Christian Boos

Comment:

ideas about the CookBook/ hierarchy and use of external resources

CookBook/About

@@ -14 +14 @@
 Ideally, the cookbook will be open to both suggestions for recipes and the recipes themselves.  In order for the cookbook to work, there will need to be some way to moderate or grade the solution so the users can be reasonably sure that the recipes wil work, and at worst not break their Trac.
 
+{{{
+#!div
+I think it's also worth to "collect" the existing recipes and resources on the Web, point to good ones, maybe provide some additional context for them. It would be bad to duplicate existing recipes.
+-- cboos
+}}}
+
 == "Writing" the Cookbook ==
 
-There is an ongoing discussion right now in the trac users group on how best to pull in and organize the cookbook content, what to call the cookbook, were it will live, and how it will relate to the Trac "documentation" (in the traditional sense).  More will be posted here soon as these ideas gel.
+There is an ongoing discussion right now in the trac users group on how best to pull in and organize the cookbook content, what to call the cookbook, where it will live, and how it will relate to the Trac "documentation" (in the traditional sense).  More will be posted here soon as these ideas gel.
 
 == What next? ==
 
 I created this page with the following idea in mind:  The cookbook could initially live here under {{{wiki:CookBook/<topic>/<sub_topic>/<etc.>}}}.  If I can get to where I'm not writing this any more, I might try writing some recipes to get things started.
+
+{{{
+#!div
+The {{{wiki:CookBook/<topic>}}} page itself can be used as an index.
+It can contain links to sub-topics or the recipes themselves.
+If the index grows too big, sub-topics can be created.
+Also, links to ''external'' recipes could be referenced from the index page, 
+and notes and appreciation for the recipe could be written there.
+
+E.g. the following recipe:
+ http://how-to-solutions.com/how-to-install-trac-on-windows.html
+
+could be referenced in CookBook/Installation, and discussed there.
+If later on, we have too many recipes referenced,
+sub-topics (like CookBook/Installation/Windows) could be created.
+
+Some suggestions for broad topics are:
+ - CookBook/Installation
+ - CookBook/Migration
+ - CookBook/Troubleshooting
+ 
+-- cboos
+}}}
+
 
 === Can I submit a recipe? ===
@@ -29 +59 @@
 Please stay tuned for more...!
 
-(cboos) A few suggestions for the next steps:
- - make it clear which of CookBook/ or TracCookbook/ is the right hierarchy to use. Currently this page (CookBook/About) shares the same content with TracCookbook/About, and it's not clear which one you really intend to use (one should redirect to the other, at the very least)
- - there are already quite a lot of such recipes here in the Wiki, e.g. TracNginxRecipe, PostgresqlRecipe, the various [TracInstallPlatforms platform install guides] have also most of the time a recipe-like structure as described [#Recipes above]
- - you could gather already existing recipes in sub-pages (say of CookBook/), merely linking to existing recipes for start and devise some kind of "status box" for them (submitted as of ../../.., verified by xyz  ../../.. + comments)
+{{{
+#!div
+Suggestions for the next steps:
+ - there was also a TracCookbook/ page, I think CookBook/ alone is simply easier to use (e.g. is it !TracCookbook or !TracCookBook?). I'll update the TracCookbook/About page to redirect here.
+ - there are already quite a lot of such recipes here in the Wiki, e.g. TracNginxRecipe, PostgresqlRecipe, the various [TracInstallPlatforms platform install guides] have also most of the time a recipe-like structure as described [#Recipes above]. Those should be linked from the CookBook/Installation page.
+
+-- cboos
+}}}