On Feb 1, 7:45 am, tiago almeida <tiago.b.alme...@gmail.com> wrote:
> Hello all,
>
> I really like web2py but allow me to say that the documentation in general
> is a bit lacking.
> For instance, the wiki looks to be unmantained for a long time. Also, I
> don't see a way to create pages there.
You have to register/login first.
>
> As someone pointed out a few days ago, having only the pdf as a
> documentation source is not enough.
>
> My question is: *Why is the wiki @http://wiki.web2py.comdead? *I'd be
> happy to contribute a few time writing documentation but I don't see how
> (apart from starting another wiki which doesn't make much sense when there
> is one already).
The problem is that only few people are willing to or can contribute
their time.
The wiki, among others, are community efforts.
>
> To someone starting with web2py (like me), having the documentation
> scattered all over the web is a bit hard (only today found out about
> local_import, ironically with a mail from someone pointing to the same
> problem; i have no idea what T3/t4 are (apart from seeing them somewhere),
> etc).
These might help:
http://groups.google.com/group/web2py/browse_thread/thread/69307af114440abf#
http://groups.google.com/group/web2py/browse_thread/thread/8b11ca9f8064e057#
>
> Is it possible to at least resuscitate the wiki so that it can be used as a
> de facto wiki with examples and change history etc?
It is not dead AFAIK. Your help is welcome as every little bit counts.
>
> Best regards,
> Tiago Almeida
Hi tiago,
On Feb 1, 7:45 am, tiago almeida <tiago.b.alme...@gmail.com> wrote:
> Hello all,
>
> I really like web2py but allow me to say that the documentation in general
> is a bit lacking.
> For instance, the wiki looks to be unmantained for a long time. Also, I
> don't see a way to create pages there.
You have to register/login first.
>> My question is: *Why is the wiki @http://wiki.web2py.comdead? *I'd be
> As someone pointed out a few days ago, having only the pdf as a
> documentation source is not enough.
>
> happy to contribute a few time writing documentation but I don't see howThe problem is that only few people are willing to or can contribute
> (apart from starting another wiki which doesn't make much sense when there
> is one already).
their time.
The wiki, among others, are community efforts.
>These might help:
> To someone starting with web2py (like me), having the documentation
> scattered all over the web is a bit hard (only today found out about
> local_import, ironically with a mail from someone pointing to the same
> problem; i have no idea what T3/t4 are (apart from seeing them somewhere),
> etc).
http://groups.google.com/group/web2py/browse_thread/thread/69307af114440abf#
http://groups.google.com/group/web2py/browse_thread/thread/8b11ca9f8064e057#
>
> Is it possible to at least resuscitate the wiki so that it can be used as aIt is not dead AFAIK. Your help is welcome as every little bit counts.
> de facto wiki with examples and change history etc?
>
> Best regards,
> Tiago Almeida
Your right, things are a bit scattered around. That was one of my
first observations as well. That said a wealth of documentation can be
found, but it is "scattered". The following list of resources that
gets updated fairly regularly (a big Thank You Denesl!) should get you
started.
Go to http://groups.google.com/group/web2py then choose "web2py help
& resources"
The Web2py manual (second edition) is an excellent and well organized
resource as well ($12.00 on Lulu) and well worth the 12 dollars...
Welcome
Chris
On Feb 1, 7:45 am, tiago almeida <tiago.b.alme...@gmail.com> wrote:
> Hello all,
>
> I really like web2py but allow me to say that the documentation in general
> is a bit lacking.
> For instance, the wiki looks to be unmantained for a long time. Also, I
> don't see a way to create pages there.
>
> As someone pointed out a few days ago, having only the pdf as a
> documentation source is not enough.
>
> My question is: *Why is the wiki @http://wiki.web2py.comdead? *I'd be
--For more options, visit this group at http://groups.google.com/group/web2py?hl=en.
You received this message because you are subscribed to the Google Groups "web2py-users" group.
To post to this group, send email to web...@googlegroups.com.
To unsubscribe from this group, send email to web2py+un...@googlegroups.com.
web2py.com/AlterEgo
wiki.web2py.com
web2pyslices.com
In the past people have volunteered to setup moimoin and trac. I
always agreed to link a new resource to the main web page. I do not
think this is a technological problem. I think there is not enough
motivation because the book is there. Moreover the online
documentation is very hard to maintain because code changes. For me
the easiest solution it just to revise the book once/year and
distribute new chapters (or edited chapters) for free when ready.
Personally, I could use help in fixing the docstrings and unittests so
that documentation would be automatically generated using Sphinx. This
is the only way to have docs that always up to date. You can use ANY
text from the book to improve docstrings.
Massimo
> On Mon, Feb 1, 2010 at 9:53 PM, Christopher Steel <chris.st...@gmail.com>wrote:
>
> > Hi Tiago,
>
> > Your right, things are a bit scattered around. That was one of my
> > first observations as well. That said a wealth of documentation can be
> > found, but it is "scattered". The following list of resources that
> > gets updated fairly regularly (a big Thank You Denesl!) should get you
> > started.
>
> > Go tohttp://groups.google.com/group/web2pythen choose "web2py help
> > & resources"
>
> > The Web2py manual (second edition) is an excellent and well organized
> > resource as well ($12.00 on Lulu) and well worth the 12 dollars...
>
> > Welcome
>
> > Chris
>
> > On Feb 1, 7:45 am, tiago almeida <tiago.b.alme...@gmail.com> wrote:
> > > Hello all,
>
> > > I really like web2py but allow me to say that the documentation in
> > general
> > > is a bit lacking.
> > > For instance, the wiki looks to be unmantained for a long time. Also, I
> > > don't see a way to create pages there.
>
> > > As someone pointed out a few days ago, having only the pdf as a
> > > documentation source is not enough.
>
> > > My question is: *Why is the wiki @http://wiki.web2py.comdead?*I'd be
> > > happy to contribute a few time writing documentation but I don't see how
> > > (apart from starting another wiki which doesn't make much sense when
> > there
> > > is one already).
>
> > > To someone starting with web2py (like me), having the documentation
> > > scattered all over the web is a bit hard (only today found out about
> > > local_import, ironically with a mail from someone pointing to the same
> > > problem; i have no idea what T3/t4 are (apart from seeing them
> > somewhere),
> > > etc).
>
> > > Is it possible to at least resuscitate the wiki so that it can be used as
> > a
> > > de facto wiki with examples and change history etc?
>
> > > Best regards,
> > > Tiago Almeida
>
> > --
> > You received this message because you are subscribed to the Google Groups
> > "web2py-users" group.
> > To post to this group, send email to web...@googlegroups.com.
> > To unsubscribe from this group, send email to
> > web2py+un...@googlegroups.com<web2py%2Bunsu...@googlegroups.com>
-Thadeus
On Feb 1, 9:42 pm, Thadeus Burgess <thade...@thadeusb.com> wrote:
> Because the web2py community is made up of people who use python for
> real world work and have real world jobs to make money. Django fanboys
> have nothing better to do all day than write docs in their parents
> basement:)
>
> -Thadeus
>
To unsubscribe from this group, send email to web2py+un...@googlegroups.com.
On Feb 1, 10:42 pm, Thadeus Burgess <thade...@thadeusb.com> wrote:
> Because the web2py community is made up of people who use python for
> real world work and have real world jobs to make money. Django fanboys
> have nothing better to do all day than write docs in their parents
> basement:)
>
Another reason is they have a licensing deal with Apress that allows
them to put a version of their book online: http://www.djangobook.com/
This online version lets people comment about missing content, new
features, etc, which keeps the documentation updated.
It would be awesome if web2py had such a deal, but I guess it is
easier for Django with the good press they have received from Google,
Guido, etc.
Richard
On Feb 2, 2:42 pm, Thadeus Burgess <thade...@thadeusb.com> wrote:
> Because the web2py community is made up of people who use python for
> real world work and have real world jobs to make money. Django fanboys
> have nothing better to do all day than write docs in their parents
> basement:)
>
> -Thadeus
>
However, people like me would also be willing to pay a subscription to
access a more up to date online book. Goodness me, the book is only 12
dollars or something, that's 1 dollar per month. How many hours do I
waste searching for answers and then have to waste someone else's time
by asking on the list? That's a terrible cost to the community.
Ironically, whilst Web2py enables us to fully embrace the most
efficient publishing technology that the world has ever seen, we wait
for an entire year between updates on the main documentation.
Wouldn't it be a great benefit if all that wonderful assistance given
on the group list, plus the errata, can be continually incorporated
into the book. Making happier users, a less busy list, and our top
development guru freer to put his brilliant ideas into action. We
simply need an online book. I rest my case :-)
--David
Now who is actually going to DO it ?
I can't. I work, sleep, and sometimes if I have time eat. Then I work
some more. My company is not going to pay me to write web2py
documentation.
And as my comment earlier wasn't just to be funny it is serious. Do
you have time to devote to creating an online documentation book for
web2py? If you do then by all means we're not stopping you!
-Thadeus
> --
> You received this message because you are subscribed to the Google Groups "web2py-users" group.
> To post to this group, send email to web...@googlegroups.com.
> To unsubscribe from this group, send email to web2py+un...@googlegroups.com.
You are right of course about raising the next question: who is going
to do it? But in my mind, there isn't any point in trying to cross
that bridge if influential people like Massimo wouldn't wish to go
anyway.
Where there's a will, there may be a way; but without that the
status quo shall remain. Not that the status quo is sooo bad! (apart
from the pop group, I mean) :)
On Feb 3, 7:27 pm, Thadeus Burgess <thade...@thadeusb.com> wrote:
> There is no case. We all agree.
>
> Now who is actually going to DO it ?
>
> I can't. I work, sleep, and sometimes if I have time eat. Then I work
> some more. My company is not going to pay me to write web2py
> documentation.
>
> And as my comment earlier wasn't just to be funny it is serious. Do
> you have time to devote to creating an online documentation book for
> web2py? If you do then by all means we're not stopping you!
>
> -Thadeus
>
If you start a documentation project please try to copy the php online
documentation, if you do this as an open source web2py app I would be
willing to help programming and filling it with examples ...
what do you think ... most of the work would be to write a web2py app,
some get payed for that, so it is justified because parts can be
reused ....
The current wiki has a number of recipes/explanations but it is never
going to systematically cover the entire API. It is basically a new
AlterEgo.
So how about importing the current API into the wiki (or a new app as
selecta suggests) to make it easier to fill out the documentation.
These updates could eventually be fed back into the docstrings.
On Feb 4, 8:44 am, selecta <gr...@delarue-berlin.de> wrote:
> I agree that an on-line book is a bad idea, I never liked to read text
> for humans while programming, it just distracts me, (even the nice
> book from Massimo)
> BUT
> if we had something like the php documentation it would be awesome
> The documentation (epydoc) is already quite good but the interface is
> dreadful
> If you look athttp://de.php.net/manual/en/function.preg-replace.php
On Feb 4, 3:59 am, DenesL <denes1...@yahoo.ca> wrote:
> AFAIK Massimo does not oppose but actually encourages the creation of
> more documentation in any form.
OK, I bit the bullet and did the following:
=> Registered the domain webtopy.org and signed up for a Godaddy
shared hosting (150GB disk, 1500GB/m traffic)
=> Setup a Drupal 6.15 based CMS with CKEditor
=> Started copying content from wiki (finished the initial 3 easy
docs)
http://webtopy.org/community/tips-examples
http://webtopy.org/community/
You can register for a free account and add content (Add book page),
or edit an existing page.
If there is sufficient interest in unifying all the scattered docs, I
am even willing to share admin access (FTP, drupal admin acct)
Let me know your thoughts.
Regards
Anand
>The problem is that only few people are willing to or can contribute their time.
I want to contribute in documentation so if there's a plan for
documentation , let me know and I'm ready .
Regards
Hamdy
Thanks.
You need to select "Full HTML" as the choice for the Input Format
field. Default is "Filtered HTML"
Moreover, you can obtain a "friendly URL" by filling up URL path
setting. This will result in URLs such as
http://site.domain.com/AboutUs instead of http://site.domain.com/?q=23
Probably I will prepare a short doc on adding content....
Regards
Anand
On Feb 4, 7:13 pm, tiago almeida <tiago.b.alme...@gmail.com> wrote:
> Nice. I took the liberty of posting DenesL Change log to that site
> (Formatting is messed up don't know why). Hope that is ok.
>
> Regards,
> Tiago
>
> > web2py+un...@googlegroups.com<web2py%2Bunsu...@googlegroups.com>
@tiago: No objection, be my guest.
Hi Massimo,
Well, more specifically then:
1. Do you agree that it's a good idea to use the current book to make
an online book? If not, let's forget it.
2. Do you have an opinion on what form the online book should take?
e.g. Djanjo, Cakephp, Php.net manual with comments...
3. Income. Will the online book project negatively affects the income
from the book. To make sure that this does not lead to a problem, I
propose that you make a suggestion as to how this may be compensated.
I suggest alternatives might include adsense, a subscription model,
and donations, etc for access to all the update notes. Of course,
even If the online book became the main place for the documentation to
be updated, you could still sell the paper version. This would be
something for you to decide / accept.
4. What format should we use for the text? (Markdown, please?)
5 .It is important for the domain to belong to Web2py/Massimo. May I
suggest book.web2py.com?
6. No one will take the online book project seriously unless we also
think about the roles we would need to fill. There are people in this
community with much greater project expertise than I, so please feel
free to dismiss the following. I am only making suggestions. e.g.
- Model Designer. It is crucial that the data is saved in the most
logical way for the future. This shouldn't be trusted to someone like
me! I vote for you (Massimo), if you have time. Part of my
reasoning is that you know how to design a workable versioning
system :-)
- Project Manager. Allocate tasks (and fire people!), supervise,
coordinate timeline.
- Programmers for controllers and views. Maybe split this into two:
Admin and Enduser.
- Html, CSS and JQuery effects (optional extra, can come later)
- Data Loaders to copy and paste the sections of the book. I think
I'd be good at this one, if the project manager would have me!
Sorry to ask/make these specific questions/suggestions, but without
your support (Massimo), let's be realistic, a community effort to
produce and support the online book project probably isn't going to
happen.
Thanks for listening.
--D
We don't need an online book. We need a location that has what each
peaces does in web2py. What can goin db.py, what can go in views,
what can go in controllers and an explanation of each piece and some
examples of each piece.
-wes
Search. The number one key feature is the ability to have intelligent search.
I don't think we need an online book (bad idea). I think we need
something more along the lines of like the django documentation.
A 4 to 5 part tutorial that gets you ready to use web2py in a few
hours, taking you through step by step through installation and
development line by line explaining what everything is doing in great
detail. At the end of the tutorial you have a working application,
like a pastebin or something.
Then detail sections that drill down web2py and break it up between
each of its layers. Sections explaining all of the features and
neuances of web2py. Other sections that refer to common use cases,
such as "Working with AJAX, json objects" that have everything you
would need to know using ajax/json with web2py.
Then we having the mailing list for discussions, alterego for faq,
web2pyslices for short tips.
We're just missing a real "walkthrough" and a real "indepth look" of web2py
-Thadeus
The effort of webtopy is to unify scattered docs.
An online version of documentation is not a bad idea, it allows timely
update so it is always current (ala other doc wikis).
Documentation by users for users.
On Feb 4, 11:57 am, tiago almeida <tiago.b.alme...@gmail.com> wrote:
> Why go through all this effort to just replicate what's already available in
> the PDF, to an html format?
>
> What a website can give, and a book can't, is tutorials, short tips, FAQs,
> discussions etc. Something the wiki could provide if it were open to public
> editing (or the newly createdhttp://webtopy.org/community/if it gets
> comunity support).
>
> An online version of the book is, to me, just a bad idea: it won't give any
> extra benefit in relation to the pdf and it will negatively affect the book
> sales (which might be important).
>
> Just my 2 cent.
> Best Regards,
> Tiago
> ------
>
> > web2py+un...@googlegroups.com<web2py%2Bunsu...@googlegroups.com>
Community documentation, for those who use web2py
Developer documentation, for those who contribute to web2py.
As far as developer documentation, I would be happy with lots of
comments in the code. At the very least 25% of the lines should become
meaningful comments!
For community documentation, at least
http://docs.djangoproject.com/en/1.1/ got something right :)
-Thadeus
> To unsubscribe from this group, send email to web2py+un...@googlegroups.com.
> Why go through all this effort to just replicate what's already available in
> the PDF, to an html format?
So we can constantly make it better, every day rather than every year.
> What a website can give, and a book can't, is tutorials, short tips, FAQs,
> discussions etc.
Why not link the extra notes to the book which is already the best
structured document that we have available? Why have scattered
documentation when we can concentrate it into one superb resource
(everyone here supports the DRY concept, no)?
> An online version of the book is, to me, just a bad idea: it won't give any
> extra benefit in relation to the pdf.
The main extra benefit is noted above.
> it will negatively affect the book sales (which might be important).
This may be true, but Massimo will have to assess that. There are
other ways to make money but I believe an up to date book is so
important for the Web2py project.
Best wishes
--David
You are in the business of writing online docs. These are separate
projects.
On Feb 4, 10:39 am, villas <villa...@gmail.com> wrote:
> On Feb 3, 8:58 pm, mdipierro <mdipie...@cs.depaul.edu> wrote:
>
> > Denes is right.
>
> Hi Massimo,
> Well, more specifically then:
>
> 1. Do you agree that it's a good idea to use the current book to make
> an online book? If not, let's forget it.
No. There is more marketing value in claiming there is a published
book then online documentation (the latter is no guarantee of quality
for potential corporate users of web2py). Anyway it is not an option
because I have agreements with the publisher. You can use examples,
code and screen-shots from the book not text, unless translated in a
different language.
> 2. Do you have an opinion on what form the online book should take?
> e.g. Djanjo, Cakephp, Php.net manual with comments...
No. I work on the published book. You decide the rest.
> 3. Income. Will the online book project negatively affects the income
> from the book. To make sure that this does not lead to a problem, I
> propose that you make a suggestion as to how this may be compensated.
> I suggest alternatives might include adsense, a subscription model,
> and donations, etc for access to all the update notes. Of course,
> even If the online book became the main place for the documentation to
> be updated, you could still sell the paper version. This would be
> something for you to decide / accept.
This is not a problem. The income from the book is negligible and not
the reason for having the book (the image is more important that the
revenues). You should not worry about this. If the online docs get
better than the book and nobody buys the book it is my problem, not
yours, nor web2py's.
> 4. What format should we use for the text? (Markdown, please?)
This was discussed at length before and most people said reST so we
integrated reST in wiki (which was originally markdown). This is not a
technology issue (it is easy to do conversions). The issue is writing
the text.
> 5 .It is important for the domain to belong to Web2py/Massimo. May I
> suggest book.web2py.com?
I am happy to link a new page when it contains usable information,
else it looks bad. We have done it already with the wiki, we have done
it with web2pyslices. The think is I have seen this kind of project
start many times before and never move much forward (except wiki and
web2pyslices). I think it would be safer to extend what we have and
then build another domain if necessary. Anyway, as a rule I am happy
to link any initiative originating by users if it contains useful
info.
> 6. No one will take the online book project seriously unless we also
> think about the roles we would need to fill. There are people in this
> community with much greater project expertise than I, so please feel
> free to dismiss the following. I am only making suggestions. e.g.
> - Model Designer. It is crucial that the data is saved in the most
> logical way for the future. This shouldn't be trusted to someone like
> me! I vote for you (Massimo), if you have time. Part of my
> reasoning is that you know how to design a workable versioning
> system :-)
> - Project Manager. Allocate tasks (and fire people!), supervise,
> coordinate timeline.
> - Programmers for controllers and views. Maybe split this into two:
> Admin and Enduser.
> - Html, CSS and JQuery effects (optional extra, can come later)
> - Data Loaders to copy and paste the sections of the book. I think
> I'd be good at this one, if the project manager would have me!
>
> Sorry to ask/make these specific questions/suggestions, but without
> your support (Massimo), let's be realistic, a community effort to
> produce and support the online book project probably isn't going to
> happen.
Honestly I have seen this effort start many times. People are really
motivated but it takes more effort than you think. I know it because I
did with the book. It was hard and took months of full time work even
if I knew well what I was talking about.
I strongly suggest that you start by improving the docstring by making
rest compliant and then you generate the online docs from them. You
will only need to add some overview pages and faq.
Massimo
I have started by documenting anything new I might contribute.
-Thadeus
Can you please deny updates to the wiki while we complete transferring
the pages over. Please leave the content visible though. You could
turn off logins to the wiki, probably
If you need ownership of the domain and/or the CMS site , I am open to
sharing or transferring, please let me know.
Regards
Anand
On Feb 5, 12:57 am, tiago almeida <tiago.b.alme...@gmail.com> wrote:
> Why go through all this effort to just replicate what's already available in
> the PDF, to an html format?
>
> What a website can give, and a book can't, is tutorials, short tips, FAQs,
> discussions etc. Something the wiki could provide if it were open to public
> editing (or the newly createdhttp://webtopy.org/community/if it gets
> comunity support).
>
> An online version of the book is, to me, just a bad idea: it won't give any
> extra benefit in relation to the pdf and it will negatively affect the book
> sales (which might be important).
>
> Just my 2 cent.
> Best Regards,
> Tiago
> ------
>
> > web2py+un...@googlegroups.com<web2py%2Bunsu...@googlegroups.com>
On Feb 4, 5:59 pm, Anand Vaidya <anandvaidya...@gmail.com> wrote:
> Request to Massimo:
>
> Can you please deny updates to the wiki while we complete transferring
> the pages over. Please leave the content visible though. You could
> turn off logins to the wiki, probably
>
> If you need ownership of the domain and/or the CMS site , I am open to
> sharing or transferring, please let me know.
>
> Regards
> Anand
>
> On Feb 5, 12:57 am, tiago almeida <tiago.b.alme...@gmail.com> wrote:
>
> > Why go through all this effort to just replicate what's already available in
> > the PDF, to an html format?
>
> > What a website can give, and a book can't, is tutorials, short tips, FAQs,
> > discussions etc. Something the wiki could provide if it were open to public
> > editing (or the newly createdhttp://webtopy.org/community/ifit gets
As you say, producing documentation is a massive task and does not
happen easily, or soon. Your annual book is the only reason that I am
able to use Web2py today and is *by far* the best source of
documentation.
There is therefore an obvious benefit in having all the updates,
comments, examples, errata and useful links attached to its various
sections.
However, if you don't wish to enable that, that's your choice.
Best regards,
--David