topic Re: Web Services API in Alfresco Archive

Web Services API

mojo-jojo — Thu, 02 Mar 2006 19:10:03 GMT

Can we expect better documentation for the web services API? The example code that's included with the source helps some. But could you possibly include some comments in the code to explain what is being done? Or could you put some documentation on the Wiki that demontrates and explains how to per

Re: Web Services API

davidc — Thu, 02 Mar 2006 19:38:43 GMT

We know our documentation is lacking in places and is not necessarily easy to navigate in the WIKI. There's not much point to providing all this capability if we don't inform people how to use it clearly.

To address this, we now have dedicated resource to develop and improve our documentation - not just for the Web Services API, but all APIs and administration, configuration, getting started, user guides etc.

Re: Web Services API

mojo-jojo — Thu, 02 Mar 2006 19:50:25 GMT

This is good news. When can we expect these improvements? Thanks.

Re: Web Services API

davidc — Thu, 02 Mar 2006 20:04:25 GMT

Well, it's going to be a process of continual improvement. One idea we're considering is to provide start-to-end manuals for end-users, administrators and developers (in html, pdf format) rather than lots of linked WIKI pages. Would that help? or do you like the WIKI?

Re: Web Services API

mojo-jojo — Thu, 02 Mar 2006 20:40:06 GMT

I rather have the start-to-end manuals (especially PDF so I can easily print a hard copy) because navigating around the wiki is kind of a pain.

Re: Web Services API

pmarreddy — Fri, 10 Mar 2006 15:19:26 GMT

i cant agree with you, if more people were to use alfresco we need a start to end manuals.

when i started using alfresco i couldn't understand a lot of things. it took me quite a while to even understand simple things just because of lace of proper documentation.

alfresco is a great product but if more people were to use it we have to make it easy for them to develop.

if you want to be the defacto standard, my advice is make it as simple as possible for people, so that more people will use it.

cheers prasanth

Re: Web Services API

mojo-jojo — Fri, 10 Mar 2006 17:44:21 GMT

Re: Web Services API

dominict — Sun, 27 Aug 2006 10:02:08 GMT

It would be great to see start to end docs. I have just starting looking into Alfresco and developing against (I'm coming from a DCTM background), and at the moment it is a up hill struggle; as the wiki is hard to navigate and sometimes hard to find what you are looking for. As an addition to Start to End docs, It would be good to have available the following docs:

- Javadocs for all the api, which are available (maybe they are somewhere, but I can't find them); I've had to download all the src and generate; but unfortunately some methods and params are not documented, so kinda hard to figure out what to do.

- More examples, and tutorials:
   - How to create your own Web Service
   - How to install and run JCR-RMI, with examples
   - Creating and Calling Custom beans from a client.
   - Searching and Querying the repository

One of the problems with producing hard format documention like pdf, word etc. Is that the wiki isn't updated, or the documents aren't sync'd, and as result you not sure which is the definitive resource.

Anyway, so far from what I've seen/done, it's looking good. And more docs are a bonus.

Cheers,
Dom

Re: Web Services API

landryhc — Tue, 01 Dec 2009 18:47:16 GMT

Dom,

I'd really like to develop a framework for creating formal documents with a database back end and a wiki front-end.

Use Case: Given a formal definition of a document (outline and contents) allow a document editor to publish the document framework to a wiki. Document stakeholders can post updates to fill in the required material. The editor can select material from multiple entries and post a top-level entry for the current "truth-state" for the formal document. The editor can also generate the complete formal document for approval and publication. (add polls and other features…)

Joyeaux Noel!
Huet