Hi Federico,

Here's what I suggest for the next steps for your GSoC project.

The GSoC timeline suggest stopping work on code this Monday August
9th, I think that's a good idea.

I don't see a need for more features, rather just fix the client-side
error reporting (see review message that I sent a few minutes ago),
and make sure CRUD functions work, I had problems with creating and
deleting entries in my test.

For next week I suggest that you work on the following things, in
order of priority:

1) Add technical docs, I suggest having them in your CMS as initial
content linked from the CMS home page.
What I'd like to see is a description of how the various use cases are
implemented, example for the "New Entry" use case:

==
User opens /david.new.esp, resource type of that node is "david".

Sling selects the /apps/david/new.esp script to process that request
(link to Sling servlet/script selection docs)

The new.esp script displays content entry form, embeds the ckeditor.

User fills and submits the form.

The SlingPostServlet (link to that) processes the form fields and
creates the corresponding content.
==

I think describing the use cases in such concise form would be useful
to Sling newbies, which are the target audience for this cms example.

The nice thing with having these docs in your content is that
"new.esp" for example can be a link to to that script, so people can
see it live immediately. /content/david can link to the json
representation of that node, etc.

As for the use cases to document I suggest:

Create new entry
List existing entries
Edit existing entry
Delete existing entry
Generate the tags content structure
Display tags using the Flash-based animation
List entries by tags
Search for entries
Create PDF renditions

2) Cleanup and comment the ESP and Java code
Make sure each source file includes a short comment that describes its purpose.
Point to Sling docs where appropriate in comments, using sling.apache.org URLs.
Remove any dead code.

If you can do these two things next week I think that would nicely
wrap up your project, and make it useful to Sling newbies.

I'll be traveling part of next week and the week after, so make sure
you submit the complete code as a patch to SLING-1438 before August
12th, even if not all docs are done by then. Tick the "Grant license
to ASF for inclusion in ASF works" if you agree with that, so that we
can eventually add the example to the Sling codebase.

As I already said, I'll do my final mentor evaluation of your GSoC
work in a week from now, August 12th or 13th, so make sure everything
looks good by then!

Thanks for your work,
-Bertrand

Reply via email to