[ 
https://issues.apache.org/jira/browse/OODT-614?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13762257#comment-13762257
 ] 

Rishi Verma commented on OODT-614:
----------------------------------

Hey Ross,

I was thinking, it would be very useful to initially document your new 
end-points within the web-app itself. For example, having a "usage page" at the 
root context that outlines the available end-points and their expected 
arguments. i.e. navigating to http://localhost:8080/fmprod/ could provide a 
top-level usage statement. You could use this documentation as initial content 
within your guides listed above as well.

What do you think?

rishi 
                
> Add project documentation to the OODT wiki
> ------------------------------------------
>
>                 Key: OODT-614
>                 URL: https://issues.apache.org/jira/browse/OODT-614
>             Project: OODT
>          Issue Type: Sub-task
>          Components: product server
>    Affects Versions: 0.6
>            Reporter: Ross Laidlaw
>            Assignee: Ross Laidlaw
>              Labels: gsoc2013
>             Fix For: 0.7
>
>
> It would be useful to provide the following guides:
> 1) Setup guide for the web application (deployment, configuration, etc).
> 2) URL examples (similar to the [File Manager REST API 
> guide|https://cwiki.apache.org/confluence/display/OODT/File+Manager+REST+API]).
> 3) Developer guide (explanation of design, tips on how to add new output 
> formats)

--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators
For more information on JIRA, see: http://www.atlassian.com/software/jira

Reply via email to