>From the perspective of a beginner, I found it impossible to assist in
the updating of the Askeet tutorial.  I wasted a lot of time trying to
get improvements to the documentation in.  I did offer and try a
number of times to update Askeet in this way, ie a refresh, not major
changes but updates to fix the errors and add new useful information.
As a beginner I had a lot of trouble following Askeet, so I thought I
would use my experience to improve it.

Unfortunately things didn't work out.  I found nothing but frustration
and confusion in trying to get improvements to the documentation
approved.

First, I asked around how to do it.  Eventually, after searching and
asking a lot, somehow I got svn commit access.  As I was very new, I
just followed what I thought was the right thing to do, which was
submit directly to svn. Of course this was wrong, but there were no
real documents on the time on what the right process was. (there are
better ones now I think, but I had to ask where they are, they weren't
easy to find at the time).

I started with the first chapter, corrected some mistakes and added
some new information which I thought would be useful.  My plan was to
go through the whole set of 24.  It took me a day to do my revisions
to just the first chapter, so I knew I was in for a long haul.

I submitted changes directly to svn.  My changes were asked to be
rolled back, as there were a few errors - my bad.  Also the proper
process was then given to me (via email):  First, submit a ticket re
your change, then submit changes to the text via a patch, then ask for
someone to review it.

I did this, but .... No one reviewed my ticket.  I asked a few times.
It wasn't even rejected.  Its just sitting there.  The ticket is still
open: http://trac.symfony-project.com/ticket/3248

So I stopped updating Askeet.  The reason being that my spirit was
broken, my enthusiasm spent.  I spent a long time to make sure the doc
patch was good, the change is available for review, but no one reviews
it, so it never gets in.

I'm sure somehow, I'm just lost in the process and people want fixes
to the docs to happen.  But I did try, and nothing happened.  I put
all my learnings from when I had trouble with the tutorial in there,
so I think its good information.  It certainly would have helped me
when I was starting out.

There is no shortage of people who want to fix Askeet.  Its the
process that stops us.  Fix the process, and Askeet will be fixed.

The fix is easy:  Put documentation like Askeet into a Wiki, so we can
actually fix it.  svn is a bad idea for documentation like Askeet
because it makes the review/fix/publish process really hard and slow.
The basic structure of Askeet is sound, its a very good footing to
start with.  So a wiki is perfect to fix it.  (I see wikis being good
for minor fixes, bad for major structural changes, but that is my
opinion).  So a perfect way to fix Askeet is a wiki.  Its not the best
way to start the documentation off, because it needs structure at the
start.  But now it is mainly done, let the community fix it where it
needs minor patches.

I can't imagine why its not in a wiki already.  If Askeet was in a
wiki, we wouldn't be having this discussion at all.  The errors would
all have been corrected by now.


On Jun 28, 9:25 pm, Fabian Lange <[EMAIL PROTECTED]>
wrote:
> Just a side note.
> For my opinion askeet needs a rewrite.
> A major hassle with askeet is that it has become very inconsistent over
> time. You can find a lot: "this is named like that here and in chapter x its
> named like that" tickets.
>
> I guess most of the correction sso far have been made without walking
> through the tutorial again which made it become even more out of sync with
> the repo files.
>
> So it would need someone who recreates askeet and documents it along.
>
> .: Fabian
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"symfony developers" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/symfony-devs?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to