You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@shindig.apache.org by "David Primmer (JIRA)" <ji...@apache.org> on 2008/05/16 01:36:55 UTC
[jira] Created: (SHINDIG-270) Produce intro developer docs for the
Restful api server
Produce intro developer docs for the Restful api server
-------------------------------------------------------
Key: SHINDIG-270
URL: https://issues.apache.org/jira/browse/SHINDIG-270
Project: Shindig
Issue Type: Improvement
Components: RESTful API (Java)
Reporter: David Primmer
Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-270) Produce intro developer docs for
the Restful api server
Posted by "Cassie Doll (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-270?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12599849#action_12599849 ]
Cassie Doll commented on SHINDIG-270:
-------------------------------------
In my mind, committing something is better than nothing. (especially with Google I/O coming up) So - I am going to be committing these files in the base social-api directory in readme form. We can use the SHINDIG-283 issue to track the fact that we need to organize our documentation better.
> Produce intro developer docs for the Restful api server
> -------------------------------------------------------
>
> Key: SHINDIG-270
> URL: https://issues.apache.org/jira/browse/SHINDIG-270
> Project: Shindig
> Issue Type: Improvement
> Components: RESTful API (Java)
> Reporter: David Primmer
> Attachments: social-api_server_walkthrough-1-dispatching.txt, social-api_server_walkthrough-2-adapter.txt
>
>
> Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (SHINDIG-270) Produce intro developer docs for the
Restful api server
Posted by "David Primmer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-270?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
David Primmer updated SHINDIG-270:
----------------------------------
Attachment: social-api_server_walkthrough-2-adapter.txt
> Produce intro developer docs for the Restful api server
> -------------------------------------------------------
>
> Key: SHINDIG-270
> URL: https://issues.apache.org/jira/browse/SHINDIG-270
> Project: Shindig
> Issue Type: Improvement
> Components: RESTful API (Java)
> Reporter: David Primmer
> Attachments: social-api_server_walkthrough-1-dispatching.txt, social-api_server_walkthrough-2-adapter.txt
>
>
> Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Closed: (SHINDIG-270) Produce intro developer docs for the
Restful api server
Posted by "Cassie Doll (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-270?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Cassie Doll closed SHINDIG-270.
-------------------------------
Resolution: Fixed
Assignee: Cassie Doll
> Produce intro developer docs for the Restful api server
> -------------------------------------------------------
>
> Key: SHINDIG-270
> URL: https://issues.apache.org/jira/browse/SHINDIG-270
> Project: Shindig
> Issue Type: Improvement
> Components: RESTful API (Java)
> Reporter: David Primmer
> Assignee: Cassie Doll
> Attachments: social-api_server_walkthrough-1-dispatching.txt, social-api_server_walkthrough-2-adapter.txt
>
>
> Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Updated: (SHINDIG-270) Produce intro developer docs for the
Restful api server
Posted by "David Primmer (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-270?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
David Primmer updated SHINDIG-270:
----------------------------------
Attachment: social-api_server_walkthrough-1-dispatching.txt
> Produce intro developer docs for the Restful api server
> -------------------------------------------------------
>
> Key: SHINDIG-270
> URL: https://issues.apache.org/jira/browse/SHINDIG-270
> Project: Shindig
> Issue Type: Improvement
> Components: RESTful API (Java)
> Reporter: David Primmer
> Attachments: social-api_server_walkthrough-1-dispatching.txt, social-api_server_walkthrough-2-adapter.txt
>
>
> Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-270) Produce intro developer docs for
the Restful api server
Posted by "Vincent Siveton (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-270?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598272#action_12598272 ]
Vincent Siveton commented on SHINDIG-270:
-----------------------------------------
IMHO I prefer another idea rather than README files
> Produce intro developer docs for the Restful api server
> -------------------------------------------------------
>
> Key: SHINDIG-270
> URL: https://issues.apache.org/jira/browse/SHINDIG-270
> Project: Shindig
> Issue Type: Improvement
> Components: RESTful API (Java)
> Reporter: David Primmer
> Attachments: social-api_server_walkthrough-1-dispatching.txt, social-api_server_walkthrough-2-adapter.txt
>
>
> Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-270) Produce intro developer docs for
the Restful api server
Posted by "Santiago Gala (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-270?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598302#action_12598302 ]
Santiago Gala commented on SHINDIG-270:
---------------------------------------
I prefer README files, though. We are trying to keep lean and as free of dependencies as possible the shindig codebase, and third parties are welcome to produce further documentation around it, as it is already happening. Having a certain entry barrier for the codebase at the current level of development is, IMO, "A Good Thing (TM)"
> Produce intro developer docs for the Restful api server
> -------------------------------------------------------
>
> Key: SHINDIG-270
> URL: https://issues.apache.org/jira/browse/SHINDIG-270
> Project: Shindig
> Issue Type: Improvement
> Components: RESTful API (Java)
> Reporter: David Primmer
> Attachments: social-api_server_walkthrough-1-dispatching.txt, social-api_server_walkthrough-2-adapter.txt
>
>
> Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (SHINDIG-270) Produce intro developer docs for
the Restful api server
Posted by "Cassie Doll (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/SHINDIG-270?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12597965#action_12597965 ]
Cassie Doll commented on SHINDIG-270:
-------------------------------------
Perhaps README files along with the code?
> Produce intro developer docs for the Restful api server
> -------------------------------------------------------
>
> Key: SHINDIG-270
> URL: https://issues.apache.org/jira/browse/SHINDIG-270
> Project: Shindig
> Issue Type: Improvement
> Components: RESTful API (Java)
> Reporter: David Primmer
> Attachments: social-api_server_walkthrough-1-dispatching.txt, social-api_server_walkthrough-2-adapter.txt
>
>
> Docs should give developers of the server and those who wish to customize it a quick overview of the code and provide a walkthrough of the request processing in the server. question: where should the docs go in svn?
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.