A step wise tutorial : documentation complete [#330921]

Per brmassa comment

I installed OAuth today and felt immediately lost when I started looking for documentation either in txt files or in the manual. The fact you can find half-started tutorials (which stop right when the fun would be about to begin) is even worse. Anyway, I'm not here to criticize, but just to share my experience and maybe offer my help for documentation.

I recognize writing tutorials is a quite difficult and time-requiring task, so I'd suggest to start making a simple list of steps to explain how to create 2 sites and get one use the OAuth service of the other.

Also it would be cool to offer a very basic module to start with. This way you can get OAuth working in minutes and start hacking from there.

What are your thoughts?

Comments

Comment #1

flevour CreditAttribution: flevour commented 6 November 2008 at 17:07

I messed up the first line. It should read "per brmass comment" about the incomplete manual, I'm creating this separate issue.

Comment #2

brmassa CreditAttribution: brmassa commented 6 November 2008 at 21:13

Francesco,

Its great to hear about your interest. i will try to find some time to improve the docs to a "minimal useful point" at least.

regards,

massa

Comment #3

flevour CreditAttribution: flevour commented 6 November 2008 at 22:34

I was suggesting to add a minimal list here so we can expand it later into the tutorial. Anyway it's up to you to decide of course!
Talk soon,
Francesco

Comment #4

brmassa CreditAttribution: brmassa commented 11 November 2008 at 03:12

Assigned:

Unassigned

» brmassa

Francesco,

i just added a basic OAuth Test module that does a basic OAuth + Web Services integration. It might be reused by any module developer as a blue print. It currently only uses XML-RPC as communication, but we might expand it in the future to other server types.

I ask everyone to take a look on this module and study it. When the concepts and techniques are mastered, help on improving the documentation.

regards,

massa

PS: the new module is part of the OAuth module and its only available on CVS and -dev versions.