Thread: PG Collaborative structure is ready for initial testing

Hi everyone,

The new "Collaborative development" side of things for the PostgreSQL
Techdocs site is ready for an initial test run:

http://techdocs.postgresql.org/guides

Could a few people with a few minutes to spare please test it out, play
with the Edit ability, add a new page or two, and generally have a go
and see if anything breaks?

If everyone agrees the basics are working, we can look to start using it
and add extra functionality as required.

At the moment there isn't any user authentication, but that can be added
later as we all gain familiarity with it and see if this approach will
work alright.

:-)

Regards and best wishes,

Justin Clift

--
"My grandfather once told me that there are two kinds of people: those
who work and those who take the credit. He told me to try to be in the
first group; there was less competition there."
   - Indira Gandhi

Justin,

> http://techdocs.postgresql.org/guides
>
> Could a few people with a few minutes to spare please test it out,
> play
> with the Edit ability, add a new page or two, and generally have a go
> and see if anything breaks?
>
> If everyone agrees the basics are working, we can look to start using
> it
> and add extra functionality as required.

No bugs in Konqueror 2.2.

Questions:
1.  Where is the "add page" link?
2.  Will there be any way to revert changes if someone screws stuff up?
3.  The formatting seems to follow some sort of puunctuation-based
coding that is not HTML.   What are the rules for this?

-Josh Berkus

Josh Berkus wrote:
<snip>
> No bugs in Konqueror 2.2.

Cool.  :)

Thanks for testing this Josh.


> Questions:
> 1.  Where is the "add page" link?

Good thought.  Will look into adding a page that accepts the input of a
page name, then creates it and takes the person there.  Sound ok?

The Help page (http://techdocs.postgresql.org/guides/HelpPage) explains
that adding a new page is as simple as going to the intended URL, but
that's non-intuitive.  People are used to being able to do stuff like
"Add Page" through click on buttons.


> 2.  Will there be any way to revert changes if someone screws stuff up?

It does have versioning built in, so we can roll back changes.  Not sure
how to just yet, but will find out.  :)

> 3.  The formatting seems to follow some sort of puunctuation-based
> coding that is not HTML.   What are the rules for this?

Added the rules for this to the Help page a little while ago:

(http://techdocs.postgresql.org/guides/HelpPage)

Do you feel they're explained well enough?

:-)

Regards and best wishes,

Justin Clift


> -Josh Berkus

--
"My grandfather once told me that there are two kinds of people: those
who work and those who take the credit. He told me to try to be in the
first group; there was less competition there."
   - Indira Gandhi

On Saturday 09 Nov 2002 8:47 am, Justin Clift wrote:
> Could a few people with a few minutes to spare please test it out, play
> with the Edit ability, add a new page or two, and generally have a go
> and see if anything breaks?

Edited a page, added one of my own - all seemed OK. Mozilla on Linux

Looking at Josh's comments and your reply, I have nothing to add re:
usability.

One suggestion - is there a "site-map" page that people could call up before
they add their own - to try and impose some sort of order & prevent
duplication.

--
  Richard Huxton
  Archonet Ltd

Richard Huxton wrote:
>
<snip>
> One suggestion - is there a "site-map" page that people could call up before
> they add their own - to try and impose some sort of order & prevent
> duplication.

Hmmm.  Good thought.  Haven't come across a Sitemap facility in Zwiki,
but it couldn't hurt to ask them if one exists.

:)

Regards and best wishes,

Justin Clift


> --
>   Richard Huxton
>   Archonet Ltd

--
"My grandfather once told me that there are two kinds of people: those
who work and those who take the credit. He told me to try to be in the
first group; there was less competition there."
   - Indira Gandhi

I don't know if it is needed but here is a link of a sitemap generator script

http://freshmeat.net/projects/sitemap/?topic_id=861

Regards Ewald



Justin Clift schrieb:

Richard Huxton wrote: 

<snip> 

One suggestion - is there a "site-map" page that people could call up before
they add their own - to try and impose some sort of order & prevent
duplication.   

Hmmm.  Good thought.  Haven't come across a Sitemap facility in Zwiki,
but it couldn't hurt to ask them if one exists.

:)

Regards and best wishes,

Justin Clift

 

-- Richard Huxton Archonet Ltd   

On 9 Nov 2002 at 19:47, Justin Clift wrote:

> Hi everyone,
>
> The new "Collaborative development" side of things for the PostgreSQL
> Techdocs site is ready for an initial test run:
>
> http://techdocs.postgresql.org/guides
>
> Could a few people with a few minutes to spare please test it out, play
> with the Edit ability, add a new page or two, and generally have a go
> and see if anything breaks?

Had a shot at it for disk tuning guide. Looks good to me. Let's bring it in
production but we need to have authentication in place otherwise people will
fill it with junk( in worst case that is..)

Can we have moderation there for guests? We could notify back user that changes
are accepted if he/she cares to leave an e-mail address there. Then we would
have few truseted users and always welcome guests..;-)

Bye
 Shridhar

--
IBM's original motto:    Cogito ergo vendo; vendo ergo sum.

Shridhar Daithankar wrote:
<snip>
> Had a shot at it for disk tuning guide. Looks good to me. Let's bring it in
> production but we need to have authentication in place otherwise people will
> fill it with junk( in worst case that is..)

The present dilemma is that the PostgreSQL users database that we
presently use for registering people on the Techdocs site isn't yet tied
to the Zope authentication scheme.

It's easy to manually create users in Zope and restrict the editing or
creation of pages to them, but our best long term situation is to allow
the people who have already registered to make use of that.

> Can we have moderation there for guests? We could notify back user that changes
> are accepted if he/she cares to leave an e-mail address there. Then we would
> have few truseted users and always welcome guests..;-)

A feature that needs to be added is the ability for people to
"subscribe" to a page, so that whenever the page is changed it gets
emailed out to them.  This is already possible, but will take about an
hour or so to read through the docs (have the right ones already marked)
then setup.  It's important to get done before the new infrastructure is
announced to the general public.

As for a moderation/review process... preferably not.  Am trying to
implement a way of doing things that makes things as easy as possible,
and in the PostgreSQL Community that will probably work.  If however
page vandals routinely turn up we'll have to rethink it.

:-)

Regards and best wishes,

Justin Clift

> Bye
>  Shridhar
>
> --
> IBM's original motto:   Cogito ergo vendo; vendo ergo sum.
>
> ---------------------------(end of broadcast)---------------------------
> TIP 3: if posting/reading through Usenet, please send an appropriate
> subscribe-nomail command to majordomo@postgresql.org so that your
> message can get through to the mailing list cleanly

--
"My grandfather once told me that there are two kinds of people: those
who work and those who take the credit. He told me to try to be in the
first group; there was less competition there."
   - Indira Gandhi

On Monday 11 Nov 2002 1:58 pm, Justin Clift wrote:
> Shridhar Daithankar wrote:
> <snip>
>
> > Had a shot at it for disk tuning guide. Looks good to me. Let's bring it
> > in production but we need to have authentication in place otherwise
> > people will fill it with junk( in worst case that is..)
>
> The present dilemma is that the PostgreSQL users database that we
> presently use for registering people on the Techdocs site isn't yet tied
> to the Zope authentication scheme.
>
> It's easy to manually create users in Zope and restrict the editing or
> creation of pages to them, but our best long term situation is to allow
> the people who have already registered to make use of that.

What about people who've subscribed/posted to pgsql-advocacy/docs? All a new
user would need to do is post an "I intend to write X" message - email gets
slurped and account created. Gives somewhere to discuss new docs, point out
existing stuff etc.

> > Can we have moderation there for guests? We could notify back user that
> > changes are accepted if he/she cares to leave an e-mail address there.
> > Then we would have few truseted users and always welcome guests..;-)
>
> A feature that needs to be added is the ability for people to
> "subscribe" to a page, so that whenever the page is changed it gets
> emailed out to them.  This is already possible, but will take about an
> hour or so to read through the docs (have the right ones already marked)
> then setup.  It's important to get done before the new infrastructure is
> announced to the general public.

Two things I noted when I was thinking about this the other day:

1. A "diff" function for two versions of the same document
2. Some way of identifying docs that need updating when 7.3, 7.4, 8.0 come
out.

> As for a moderation/review process... preferably not.  Am trying to
> implement a way of doing things that makes things as easy as possible,
> and in the PostgreSQL Community that will probably work.  If however
> page vandals routinely turn up we'll have to rethink it.

Something fairly lightweight certainly.

--
  Richard Huxton

Richard Huxton wrote:
>
<snip>
> > It's easy to manually create users in Zope and restrict the editing or
> > creation of pages to them, but our best long term situation is to allow
> > the people who have already registered to make use of that.
>
> What about people who've subscribed/posted to pgsql-advocacy/docs? All a new
> user would need to do is post an "I intend to write X" message - email gets
> slurped and account created. Gives somewhere to discuss new docs, point out
> existing stuff etc.

Not sure what you mean.  :-/

<snip>
> > A feature that needs to be added is the ability for people to
> > "subscribe" to a page, so that whenever the page is changed it gets
> > emailed out to them.  This is already possible, but will take about an
> > hour or so to read through the docs (have the right ones already marked)
> > then setup.  It's important to get done before the new infrastructure is
> > announced to the general public.
>
> Two things I noted when I was thinking about this the other day:
>
> 1. A "diff" function for two versions of the same document

Good thought.  With the present collaborative infrastructure, one of the
options that can be turned on (and probably worth doing so) is that when
someone edits a page directly, it's actually a "diff" of it that's
emailed to all the people that have "subscribed" to that page.  Not sure
that this is what you meant, but worth mentioning.

> 2. Some way of identifying docs that need updating when 7.3, 7.4, 8.0 come
> out.

Good point.  Maybe someone embedding a tag in docs that can be scanned
for, showing the PostgreSQL version they're relevant for?

Regards and best wishes,

Justin Clift


<snip>
> --
>   Richard Huxton

--
"My grandfather once told me that there are two kinds of people: those
who work and those who take the credit. He told me to try to be in the
first group; there was less competition there."
   - Indira Gandhi