See below On 03/12/2015 11:56, Eduard Moraru wrote:
Hi,
Nice initiative.
I guess you should also mention that your proposal is only about replacing the API Documentation section[1] inside the REST documentation page[2] and not about replacing the whole documentation page with this application. As far as I can see, this application is highly focused/structured on the API, but the documentation page contains much more than just API and we should/could not force all the page's sections into a flat-structured livetable. Yes, of course, and I can think also about 2 others pages that could benefit that application too. http://extensions.xwiki.org/xwiki/bin/view/Extension/Repository+Module http://extensions.xwiki.org/xwiki/bin/view/Extension/XFF+REST+API
+1 to integrating the API application into the documentation page and not the other way around (i.e. not as Vincent's point 3), above). Yes, I picture a livetable instead of the long list of entry points (and the rest of the documentation stay as it is).
Thanks, Eduard
---------- [1] http://platform.xwiki.org/xwiki/bin/view/Features/XWikiRESTfulAPI#HXWikiREST... [2] http://platform.xwiki.org/xwiki/bin/view/Features/XWikiRESTfulAPI
On Thu, Dec 3, 2015 at 10:15 AM, Thomas Mortagne <[email protected]> wrote:
+1
On Wed, Dec 2, 2015 at 7:34 PM, [email protected] <[email protected]> wrote:
Hi Jean,
Very nice, +1 to start using it and tune it as we progress.
I think the steps would be:
1) Commit the app in xwiki-contrib 2) Install it in xwiki.org (if others agree) 3) migrate REST doc to it progressively
Thanks -Vincent
On 2 Dec 2015 at 19:07:28, Jean SIMARD ([email protected](mailto: [email protected])) wrote:
Hi devs,
REST service of XWiki is pretty good. And the documentation is almost complete... but it's a long, long page, a bit difficult to read and to find the information.
But hey, guess what? XWiki is a perfect tool to document that. So I've started a prototype with AWM to do that.
On the following link, you'll find a few images and a XAR with the application and a few samples of REST documentation.
http://dev.xwiki.org/xwiki/bin/view/Drafts/REST+AWM
Tell me what you think.
Thanks, -- Jean Simard
devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Thomas Mortagne _______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
-- Jean Simard [email protected] Research engineer at XWiki SAS http://www.xwiki.com Committer on the XWiki.org project http://www.xwiki.org