Volunteer for a documentation update?

27 views
Skip to first unread message

Maxim Shafirov

unread,
Jan 28, 2013, 12:08:26 PM1/28/13
to karafr...@googlegroups.com
Hi,

I've proposed and implemented some changes recently, which requires documentation to be updated. The most significant is Controllers -> Routes refactoring. I'm not exactly a tech writing master so is there any volunteer for that?
Another thing, that probably needs to be updated is Hadi's "how to get started".

Andrey Cheptsov

unread,
Jan 28, 2013, 12:12:47 PM1/28/13
to karafr...@googlegroups.com
I can update the docs a bit later on this week.
Would you mind adding info about dependencies options and including my JPA application to samples? it would be also good to setup a blog post or just a web page where we could share tutorials.

Hadi Hariri

unread,
Jan 28, 2013, 3:51:25 PM1/28/13
to karafr...@googlegroups.com
I can update the getting started video.

Maxim Shafirov

unread,
Jan 29, 2013, 3:23:30 AM1/29/13
to karafr...@googlegroups.com
Cool!

Please note 
- there's CI set up for Kara, so there's binary distribution for those, who intend to use Kara rather than develop it (mentioned in readme.md). 
- generated IDEA project has run configuration to start up the server, so it can be debugged out of the box.
- Kara no longer copies it's runtime to the generated project (so no update command is necessary). When the generated project is opened for the first time one has to define KARA_HOME path variable so runtime libraries linked to the project can be resolved.

Andy Selvig

unread,
Feb 1, 2013, 1:59:56 PM2/1/13
to karafr...@googlegroups.com
Andrey- Are you still planning on updating the routing docs? If not, I can do it as well. This was a pretty large change, so I feel bad that the documentation is very misleading.

Regarding the sample/tutorials, maybe it makes sense to just add an extra page to the website?

Andrey Cheptsov

unread,
Feb 1, 2013, 2:05:33 PM2/1/13
to Andy Selvig, karafr...@googlegroups.com
Hi Andy,

Sorry for a delay, it was a tough week. Hope to do it tomorrow.

What about adding info on ivy support (I have added it) and a sample with JPA and Twitter Bootstrap?

Andrey

01.02.2013, в 22:59, Andy Selvig <ajse...@gmail.com> написал(а):

--
You received this message because you are subscribed to the Google Groups "Kara Framework" group.
To unsubscribe from this group and stop receiving emails from it, send an email to karaframewor...@googlegroups.com.
To post to this group, send email to karafr...@googlegroups.com.
Visit this group at http://groups.google.com/group/karaframework?hl=en.
For more options, visit https://groups.google.com/groups/opt_out.
 
 

Andrey Cheptsov

unread,
Feb 1, 2013, 2:07:42 PM2/1/13
to Andy Selvig, karafr...@googlegroups.com
As for ivy support, currently it retrieve libraries into lib folder. I consider to change it to retrieve them into a temporary folder outside of application to avoid conflicts, etc.

Let me know what you think.

Andrey

01.02.2013, в 23:05, Andrey Cheptsov <andrey....@gmail.com> написал(а):

Andy Selvig

unread,
Feb 1, 2013, 2:12:27 PM2/1/13
to Andrey Cheptsov, karafr...@googlegroups.com
Sorry for a delay, it was a tough week. Hope to do it tomorrow.
Not a problem, just making sure we're not duplicating effort.

As for ivy support, currently it retrieve libraries into lib folder. I consider to change it to retrieve them into a temporary folder outside of application to avoid conflicts, etc.
I think putting everything in the lib folder is good. Since KaraLib.jar was removed from there for the time being, it shouldn't cause any conflicts. And yes, please document this feature both in the KaraExec help text and the Command Line page.

Let's add a tutorials/examples page to the site where we can link to the JPA and Bootstrap examples. I assume their both on Github?

Andrey Cheptsov

unread,
Feb 1, 2013, 2:16:06 PM2/1/13
to Andy Selvig, karafr...@googlegroups.com
Right, will do.

01.02.2013, в 22:59, Andy Selvig <ajse...@gmail.com> написал(а):

Andrey Cheptsov

unread,
Feb 2, 2013, 9:19:46 AM2/2/13
to Andy Selvig, karafr...@googlegroups.com
Andy,

Should I make a pull request or commit to the original repo?

01.02.2013, в 23:12, Andy Selvig <ajse...@gmail.com> написал(а):

Andy Selvig

unread,
Feb 2, 2013, 10:09:44 AM2/2/13
to Andrey Cheptsov, karafr...@googlegroups.com
Right now you'll have to make a pull request, but I can add you as a contributor to the project if you'd like, so you can push changes directly.

Andrey Cheptsov

unread,
Feb 2, 2013, 10:14:58 AM2/2/13
to Andy Selvig, karafr...@googlegroups.com
Yes, adding me as a contributor would be useful, thanks!

02.02.2013, в 19:09, Andy Selvig <ajse...@gmail.com> написал(а):
Reply all
Reply to author
Forward
0 new messages