About website, docs etc.

Daniele Varrazzo <[email protected]> Wed, 17 Feb 2010 10:29:57 +0000
Newsgroups gmane.comp.python.db.psycopg.devel
Message-ID <[email protected]>
Hello,

the last couple of week has been full of events: license change, new
documentation, and if you haven't noticed yet, the homepage at
http://initd.org/ is no more unwelcoming as it has been in the last
couple of years (well, in case you miss it, the rant is still
reachable at /down.html...)

Well, the homepage is not in a 2.0 bells and whistles style. ...it
also looks suspiciously similar to the documentation... but you know,
once you have an hammer...

Anyway, I'm proud of the fact that the relationship between Python and
Postgres is back on the right track.

I'd like to ask the list "where do we go from here"? A few points I
have in mind:

- Which are the critical informations missing from the webpage? Or
also less critical but you'd like to see addressed?

- I'd say we definitely need a FAQ section where to provide direct
solution to the gotchas a new user may find. I am not exactly a
newcomer so I may start filling it but I would surely need an hand
getting back in a newcomer's shoes. Can you help me to find the "right
questions"? Somebody has mentioned a previously existing FAQ: is it
still available/useful?

- For the previous point, probably a collaborative area would be the
best tool. Probably nobody of us is willing to set up a complete wiki
and start fighting the spam, so I'd say we could borrow a page from
Python's or PG's wiki and write it there. They have recently set up
http://wiki.postgresql.org/wiki/Psycopg : we may fill a FAQ section
here. What do you think?

- The documentation has been written by a non-native speaker: I'd
really like to have it reviewed and have the strongest Italianisms
fixed. So, if you read any sentence that makes mandolins ringing in
your ears, please tell me :)

If you'd like to contribute material to the website or to the
documentation, once in a lifetime I feel saying just give me/us the
idea and I'll be glad to add it (I do because I know there is not much
work left after all). But, in case you feel like writing a page, or a
css, or fixing something, you can grab everything from the branches
"website" and "docs" on http://piro.develer.com/psycopg2.git and shout
when you have something to pull (gitweb is here [1] if you want to
peek).

Well, this was mostly a random list of points I have in mind. As I
said, I don't think there is much more work to do, so I'd like to
avoid a long tail of half baked pieces and quickly "finish the job",
ideally for the 2.0.14 release. I'd like to thank Federico for his
work by caring about the things the project may benefit of, but he
doesn't have time to address himself. So, if anybody else wants to
help, you are most welcome.

Thank you very much.

-- Daniele

[1] https://www.develer.com/gitweb/pub?p=users/piro/psycopg2.git;a=summary