[richfaces-issues] [JBoss JIRA] Commented: (RF-7253) Cookbook format

[Michael Sorokin (JIRA)]

    [ https://jira.jboss.org/jira/browse/RF-7253?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12469126#action_12469126 ] 

Michael Sorokin commented on RF-7253:
-------------------------------------

I suggest the following cookbook recipe format:

Recipe 1.1  Recipe Name

--Problem

The problem is clearly set in this section.
Example:
You need to change the layout of a page on the fly. 

--Solution

Brief solution to the problem, this section should not contain any details just short and very specific solution. 
Example:
Use <rich:page>, create several custom themes  and redefine the render with the theme attribute.

-- Details
This section should provide concrete, detailed steps to solve the problem. 

-- Example (optional)

This optional section provides an example of how the problem is solved in a real environment. 


> Cookbook format 
> ----------------
>
>                 Key: RF-7253
>                 URL: https://jira.jboss.org/jira/browse/RF-7253
>             Project: RichFaces
>          Issue Type: Task
>          Components: doc
>    Affects Versions: 3.3.1
>            Reporter: Svetlana mukhina
>            Assignee: Michael Sorokin
>            Priority: Optional
>             Fix For: Site
>
>   Original Estimate: 1 hour
>  Remaining Estimate: 1 hour
>
> Cookbook pages should be formated in a similar way, provide you ideas on the format:  

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: https://jira.jboss.org/jira/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira