The web2py wiki is now ready for your input!

[Jonathan Benn]

Hi all,


The web2py documentation wiki is now ready to go. So if you're
interested in helping to document web2py's new features, or if you're
a feature developer, then please add to the wiki and help improve
web2py!

The wiki is here (you need to accept Massimo's self-signed security
certificate on your first visit):
https://mdp.cti.depaul.edu/wiki/

Good documentation is critically important to web2py's future. Good
documentation makes the difference between people using web2py and
telling their friends about it, and people giving up or trying
something else instead. It's no coincidence that all widely used
software tools are well-documented.

If you are also interested in helping to improve the Wiki itself,
Massimo has released the source code here:
https://launchpad.net/web2py-wiki


Thanks in advance,

--Jonathan

[Michael Wales]

Certificate is invalid - can eventually get to the site, but requires
some manual labor in Firefox.

[DenesL]

Good news!
IMHO we should create a basic structure, probably following the
current manual, so this does not turn into a collection of notes.

[mr.freeze]

Looks good. Will any of the content from here
https://mdp.cti.depaul.edu/web2py_wiki/default/wiki/main be moved over
or does it need to be recreated manually?

[mdipierro]

That contact needs to be converted from moarkdown to reST so I guess
it has to be done manually.

On Mar 12, 8:56 am, "mr.freeze" <nfre...@gmail.com> wrote:
> Looks good.  Will any of the content from herehttps://mdp.cti.depaul.edu/web2py_wiki/default/wiki/mainbe moved over

[Yarko Tymciurak]

On Thu, Mar 12, 2009 at 8:24 AM, Michael Wales <Evice...@gmail.com> wrote:

Certificate is invalid - can eventually get to the site, but requires
some manual labor in Firefox.

 

this is because DePaul has certificate for top level site;  I do not think this will / can be fixed.

[Wes James]

On Thu, Mar 12, 2009 at 12:00 PM, Yarko Tymciurak <yar...@gmail.com> wrote:
>
> On Thu, Mar 12, 2009 at 8:24 AM, Michael Wales <Evice...@gmail.com> wrote:
>>
>> Certificate is invalid - can eventually get to the site, but requires
>> some manual labor in Firefox.
>
>
> this is because DePaul has certificate for top level site;  I do not think
> this will / can be fixed.
>

Massimo,

Is this your machine (do you control it? apache, etc.?) If so, go
get a free 2 year ssl cert for apache at http://certs.ipsca.com/ .

-wj

[DenesL]

I see there is a "Web2py Documentation" page that could serve as the
backbone but it is getting kinda lost in the page list, is there a way
to visualize the hierarchy?.
The instructions for creating pages recommend using the menu field to
enter things like '/docs/dal' to keep the pages organized but which
'nodes' are already created?.

[DenesL]

By that I mean I can see the index with the [+]s but the links are a
bunch of numbers, letters and dashes.
So which one is '/docs/examples' or '/docs/howto' ?

[maplye]

there is error when i use google chrome brower..

2009/3/13 DenesL <dene...@yahoo.ca>:

[Jonathan B]

On Mar 12, 4:34 pm, DenesL <denes1...@yahoo.ca> wrote:

> IMHO we should create a basic structure, probably following the
> current manual, so this does not turn into a collection of notes.

Please feel free to add more structure if you like.


--Jonathan

[Jonathan B]

On Mar 12, 4:56 pm, "mr.freeze" <nfre...@gmail.com> wrote:
> Looks good.  Will any of the content from herehttps://mdp.cti.depaul.edu/web2py_wiki/default/wiki/mainbe moved over

> or does it need to be recreated manually?

Thanks for mentioning this link, since I wasn't even aware of it! :-)

There doesn't seem to be a lot of content, so it won't be a big deal
converting it from Markdown to RST. I can take care of this...

--Jonathan

[Jonathan B]

On Mar 12, 9:00 pm, Yarko Tymciurak <yark...@gmail.com> wrote:

> On Thu, Mar 12, 2009 at 8:24 AM, Michael Wales <Evicera...@gmail.com> wrote:
>
> > Certificate is invalid - can eventually get to the site, but requires
> > some manual labor in Firefox.
>
> this is because DePaul has certificate for top level site;  I do not think
> this will / can be fixed.

Perhaps just reading the wiki could require HTTP, thus allowing anyone
to browse the contents, and then if you want to edit you need to sign
on via HTTPS?

I think this would be best, because we will have a major problem
trying to get the general public to use the wiki if they have to
accept a non-standard certificate just to browse.

--Jonathan

[Jonathan B]

Hi DenesL,

This is a weakness of the wiki at the moment. I've already added
something to this effect on the Wiki Todo Page. We need a better way
of structuring the wiki. Do you have any suggestions on how this might
be done well? We can take a look at other wikis and borrow a best
practice from them...

--Jonathan

[Jonathan B]

Hi maplye,

On Mar 13, 10:44 am, maplye <map...@gmail.com> wrote:

> > By that I mean I can see the index with the [+]s but the links are a
> > bunch of numbers, letters and dashes.
> > So which one is '/docs/examples' or '/docs/howto' ?

Can you please be more specific? What kind of error do you get?

--Jonathan

[DenesL]

I wish I had something to suggest, I think this was possible in the
old wiki.
Again, if participation is not made EASY and we keep it ORGANIZED,
people will not pitch in, and I see this stalling again.

[Yarko Tymciurak]

There is no need for stall

We have made some decisions to help prevent stall:   RST.

People working on Python3 Patterns book often ONLY submit RST.

Anyone who has a writeup can write off-line, edit until they like and submit.   Or work on the wiki, and wait to make public until it is edited, and ready to the author's satisfaction.

This is a good way to prepare something as a part of sphinx documentation input too.

Don't complain - just do...

Wiki only helps that people see who has what....  so you can do this also:

I've added a page:  "Topics in Progress" so you can announce pages you are working on which are not public yet.

Regards,

Yarko

[Kuba Kucharski]

There is a problem with pages/faq, internal error https://mdp.cti.depaul.edu/admin/default/ticket/wiki/83.20.71.158.2009-03-16.12-12-04.d9748d21-7374-4c31-ba71-05b0880afebe

--
K

[DenesL]

Ok, I will play devil's advocate.

Having all the bells and whistles is fine as long as:
1) They make it easy to participate.
2) They aid the structure.

examples:
it has to be in web2py: ideal but currently missing features that
hinder structural organization (roadblock)
it has to use reST, good reasons, long term vision but contributors
have to learn it and it has its quirks (roadblock)
people in general are time constrained (roadblock) lets not make it
harder.

May the yet-to-be best not kill the workable good-enough.

[Yarko Tymciurak]

This is all hypothetical as I see it.

RST and markdown both use similar notation for headings and bullits.

In any case the simplest markup is text.

What specifically is in your way now - right now, what's the next thing you need?

[Jonathan B]

Hi,


On Mar 16, 7:14 pm, Kuba Kucharski <kuba.kuchar...@gmail.com> wrote:
> There is a problem with pages/faq, internal errorhttps://mdp.cti.depaul.edu/admin/default/ticket/wiki/83.20.71.158.200...

Thanks, you are right.

The following URL gives an error:
https://mdp.cti.depaul.edu/wiki/default/page/06f7a28e-3532-4c58-866c-52174ec02a40

Massimo, can you please enable bug tracking in Launchpad so that we
can start listing and fixing Wiki bugs in an organized way?


Thanks,

--Jonathan

[Yarko Tymciurak]

I am not sure what changed that this FAQ page started erroring - I tried to make some simple changes (add new line to the end, etc.) and trying to save that errored.

There should be enough tickets now that Massimo has something to look at.

I made the page inactive (that did seem to succeed) so that people are not running into that again.

- Yarko

P.s. -  Speaking for experience from web2conf, we found bugtracking useful for deferred, longer term issues.  I would not recommend just using it for everything that will / can be fixed "immediately".   We did that for a while for the conference site, and it created a lot of work updating the bugtracker.  Conference people wondered which  bug was still valid, etc.

Regardless - report smaller things here first.   (This I would put in a tracker).

[Fred]

I had worked on that wiki FAQ page. I think I used some hyperlink
targets in the reST source (http://docutils.sourceforge.net/docs/ref/
rst/restructuredtext.html#hyperlink-targets) and I seem to recall that
the reST parser used to be fragile concerning errors in those.

But the key thing is that someone actively working on the wiki needs
admin rights so they can track down such internal errors. Also, the
wiki source itself may want some additional wrapping of the reST
parser to catch exceptions that can be caused by invalid reST code.

[Yarko Tymciurak]

Thanks for the note.  Improved error catching sounds in order.

[Anand Vaidya]

The URL http://mdp.cti.depaul.edu/wiki/ returns an "Invalid Function"
message. Only https works. Is it possible to redirect to https:// when
someone visits http://

Regards
Anand

[Jonathan B]

Hi Yarko,

On Mar 17, 7:57 pm, Yarko Tymciurak <yark...@gmail.com> wrote:

> P.s. -  Speaking for experience from web2conf, we found bugtracking useful
> for deferred, longer term issues.  I would not recommend just using it for
> everything that will / can be fixed "immediately".   We did that for a while
> for the conference site, and it created a lot of work updating the
> bugtracker.  Conference people wondered which  bug was still valid, etc.

Yes, this is a good rule of thumb with bug trackers in general. If
it's an easy fix, just fix it. If it's a hard fix, put it in the bug
tracker. This was our policy at the software company I used to work
for. My boss's rule of thumb was to put anything that might take
longer than a week to do, or that we might forget about during a
crunch period, into the bug tracker.


Thanks,

--Jonathan

[Jonathan B]

Thanks everyone for the very productive conversation thread! I've
added bugs to the bug tracker (https://bugs.launchpad.net/web2py-wiki)
and updated the Wiki so that we don't lose track of the issues that
have been brought up.

--Jonathan

[Yarko Tymciurak]

please post issues you have w/ the wiki to this group first so we can ensure:

• that it is a problem w/ the wiki (and not something else);
• that the problem is reproducible (or efforts have been made to ensure);

Thanks,

Yarko