SDLDoc maintainer

[Martin_Donlon]

Yo,
For a few years now I’ve been the maintainer of the SDL Documentation
project, we started with very little and managed to create a fairly
large SDL API reference. However, most of us have moved onto other
things and I no longer have the time or the drive to work on the
project. So I’m looking for a new maintainer to update the neglected
documentation and website. If you’re looking to give something back to
the SDL community or to improve your knowledge of SDL then replay back
here or you can contact me personally for some more info.

Martin–
http://akawaka.csn.ul.ie

[Gaetan_de_Menten]

Hello…

I think the best would be to incorporate SDL documentation
project to the main SDL website and have a (preferably rather large) group
of people with the permission to maintain it. I, for one, would be
interested to be part of that group but I couldn’t do it alone (because
of evident lack of time and of my moderate knowledge of SDL).

As for the porting the DOC project to SDL main website and its permission
system, I’ll do it if Sam agrees with the idea… But I can’t do it
right now as I’m under heavy work load for the moment.

Gaetan.On Sun, 23 Nov 2003, Martin Donlon wrote:

Yo,
For a few years now I’ve been the maintainer of the SDL Documentation
project, we started with very little and managed to create a fairly
large SDL API reference. However, most of us have moved onto other
things and I no longer have the time or the drive to work on the
project. So I’m looking for a new maintainer to update the neglected
documentation and website. If you’re looking to give something back to
the SDL community or to improve your knowledge of SDL then replay back
here or you can contact me personally for some more info.

Martin

http://akawaka.csn.ul.ie

---

SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

[John_Silicon]

I aggree – perhaps some sort of SDLDoc Wiki is in order?> ----- Original Message -----

From: ged@bugfactory.org (Gaetan de Menten)
To:
Sent: Sunday, November 23, 2003 2:09 PM
Subject: Re: [SDL] SDLDoc maintainer

Hello…

I think the best would be to incorporate SDL documentation
project to the main SDL website and have a (preferably rather large) group
of people with the permission to maintain it. I, for one, would be
interested to be part of that group but I couldn’t do it alone (because
of evident lack of time and of my moderate knowledge of SDL).

As for the porting the DOC project to SDL main website and its permission
system, I’ll do it if Sam agrees with the idea… But I can’t do it
right now as I’m under heavy work load for the moment.

Gaetan.

On Sun, 23 Nov 2003, Martin Donlon wrote:

Yo,
For a few years now I’ve been the maintainer of the SDL Documentation
project, we started with very little and managed to create a fairly
large SDL API reference. However, most of us have moved onto other
things and I no longer have the time or the drive to work on the
project. So I’m looking for a new maintainer to update the neglected
documentation and website. If you’re looking to give something back to
the SDL community or to improve your knowledge of SDL then replay back
here or you can contact me personally for some more info.

Martin

http://akawaka.csn.ul.ie

---

SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

---

SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

[Florian_Hufsky]

i don’t think a wiki is a good idea, but as gaetan wrote a larger group of
people should be responsible for the sdl docu, which should be integrated
in the sdl website!

John Silicon wrote:

I aggree – perhaps some sort of SDLDoc Wiki is in order?----- Original Message -----
From: "Gaetan de Menten"
To:
Sent: Sunday, November 23, 2003 2:09 PM
Subject: Re: [SDL] SDLDoc maintainer

Hello…

I think the best would be to incorporate SDL documentation
project to the main SDL website and have a (preferably rather large) group
of people with the permission to maintain it. I, for one, would be
interested to be part of that group but I couldn’t do it alone (because
of evident lack of time and of my moderate knowledge of SDL).

As for the porting the DOC project to SDL main website and its permission
system, I’ll do it if Sam agrees with the idea… But I can’t do it
right now as I’m under heavy work load for the moment.

Gaetan.

On Sun, 23 Nov 2003, Martin Donlon wrote:

Yo,
For a few years now I’ve been the maintainer of the SDL Documentation
project, we started with very little and managed to create a fairly
large SDL API reference. However, most of us have moved onto other
things and I no longer have the time or the drive to work on the
project. So I’m looking for a new maintainer to update the neglected
documentation and website. If you’re looking to give something back to
the SDL community or to improve your knowledge of SDL then replay back
here or you can contact me personally for some more info.

Martin

http://akawaka.csn.ul.ie

---

SDL mailing list
SDL@libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

---

SDL mailing list
SDL@libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

---

SDL mailing list
SDL@libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

[Jonas_Hartmann]

though i am completely new to this i am political active (in the real
world).

i suggest to have one maintainer, ONE person that is RESPONSIBLE. every
year this position must cycle through a group of official SDL Document
Contributers, while the one in this position have to be voted out of
this group (and while, this way it keeps to be a cycling, noone who did
that job already, can do it again if someone else who didnt do it
already, wants to do it)

to become maintainer you have to be memeber of that group for at least 2
years.

that group can be big like 20 to 50 poeple.

outside people who want to contribute can contact those people instead
of just one maintainer.

these people can make direct changes to the doc without asking before
but there have to be a notice send to all including the maintainer, and
the maintainer has the right to revert things back.

there should be regular “virtual” meetings where people vote about stuff
that was reverted by the maintainer and other problematic things.

if there are things to be created like roadmaps or so, the maintainer
collects ideas, creates suggestions and that group votes on the suggestions.

this way the maintainer is a “manager” and no single person who has all
the power in his hands AND all the work as well.

question would be how to create that group of people (official sdl
document contributers)

sorry for my bad english, just got up at 1pm

[Gaetan_de_Menten]

Sorry, but I don’t see the point of having one manager, meetings and all
this “complicated” system since “the product” is basically done and only
needs to be updated.

But IMHO, it’s a good idea to send a notice of changes to the whole
group.

Sam, you never told us your opinion on this topic, and I’d like to know
what you think…

Gaetan.On Mon, 2003-12-08 at 12:29, Jonas Hartmann wrote:

though i am completely new to this i am political active (in the real
world).

i suggest to have one maintainer, ONE person that is RESPONSIBLE. every
year this position must cycle through a group of official SDL Document
Contributers, while the one in this position have to be voted out of
this group (and while, this way it keeps to be a cycling, noone who did
that job already, can do it again if someone else who didnt do it
already, wants to do it)

to become maintainer you have to be memeber of that group for at least 2
years.

that group can be big like 20 to 50 poeple.

outside people who want to contribute can contact those people instead
of just one maintainer.

these people can make direct changes to the doc without asking before
but there have to be a notice send to all including the maintainer, and
the maintainer has the right to revert things back.

there should be regular “virtual” meetings where people vote about stuff
that was reverted by the maintainer and other problematic things.

if there are things to be created like roadmaps or so, the maintainer
collects ideas, creates suggestions and that group votes on the suggestions.

this way the maintainer is a “manager” and no single person who has all
the power in his hands AND all the work as well.

question would be how to create that group of people (official sdl
document contributers)

[Erik_Sigra]

LOL :-)> ----- Original Message -----

From: jonashartmann@gmx.de (Jonas Hartmann)
To: sdl at libsdl.org
Date: Mon, 08 Dec 2003 12:29:45 +0100
Subject: Re: [SDL] SDLDoc maintainer

though i am completely new to this i am political active (in the real world).

i suggest to have one maintainer, ONE person that is RESPONSIBLE. every year this position must cycle through a group of official SDL Document
Contributers, while the one in this position have to be voted out of
this group (and while, this way it keeps to be a cycling, noone who did
that job already, can do it again if someone else who didnt do it
already, wants to do it)

to become maintainer you have to be memeber of that group for at least 2
years.

that group can be big like 20 to 50 poeple.

outside people who want to contribute can contact those people instead
of just one maintainer.

these people can make direct changes to the doc without asking before
but there have to be a notice send to all including the maintainer, and
the maintainer has the right to revert things back.

there should be regular “virtual” meetings where people vote about stuff
that was reverted by the maintainer and other problematic things.

if there are things to be created like roadmaps or so, the maintainer
collects ideas, creates suggestions and that group votes on the suggestions.

this way the maintainer is a “manager” and no single person who has all
the power in his hands AND all the work as well.

question would be how to create that group of people (official sdl
document contributers)

sorry for my bad english, just got up at 1pm

[slouken]

Sam, you never told us your opinion on this topic, and I’d like to know
what you think…

Which topic?

See ya,
-Sam Lantinga, Software Engineer, Blizzard Entertainment

[Gaetan_de_Menten]

SDLDoc maintainers… and the fact I’d like to include SDL doc on the
main website…

Gaetan.On Tue, 2003-12-09 at 03:08, Sam Lantinga wrote:

Sam, you never told us your opinion on this topic, and I’d like to know
what you think…

Which topic?

[slouken]

I like it, if it can be migrated over without too much hassle.
Martin, do you know what it would take to move the SDLdoc website
over to libsdl.org?

See ya,
-Sam Lantinga, Software Engineer, Blizzard Entertainment> On Tue, 2003-12-09 at 03:08, Sam Lantinga wrote:

Sam, you never told us your opinion on this topic, and I’d like to know
what you think…

Which topic?

SDLDoc maintainers… and the fact I’d like to include SDL doc on the
main website…

[Florian_Hufsky]

i don’t know if this has been discussed any further (i’ve seen nothing).

so how’s the plan now?

will the sdl doc be ported to the sdl main site?
do you need some one to do this?
what’s there to be done?

bye, florian

Sam Lantinga wrote:>>On Tue, 2003-12-09 at 03:08, Sam Lantinga wrote:

Sam, you never told us your opinion on this topic, and I’d like to know
what you think…

Which topic?

SDLDoc maintainers… and the fact I’d like to include SDL doc on the
main website…

I like it, if it can be migrated over without too much hassle.
Martin, do you know what it would take to move the SDLdoc website
over to libsdl.org?

See ya,
-Sam Lantinga, Software Engineer, Blizzard Entertainment

---

SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

[Stephane_Marchesin]

Florian Hufsky wrote:

i don’t know if this has been discussed any further (i’ve seen nothing).

so how’s the plan now?

will the sdl doc be ported to the sdl main site?
do you need some one to do this?

what’s there to be done?

There are some details to add to some man pages (for example
SDL_CreateRGBSurface doesn’t always use the requested format if color
key or alpha are specified).
Some functions aren’t documented, like pbuffer ones, or the multisample
OpenGL interface, or the cpu info ones.
Maybe some faqs to add too…

That’s all I can think of right now.

I could give some hints as I’ve used those functions, but my english
isn’t as good as it should be for that kind of job (and I have limited
free time too).

Stephane

[Gaetan_de_Menten]

i don’t know if this has been discussed any further (i’ve seen nothing).

No. Or well… Nothing that I’m aware of anyway. Back then, I tried to
contact Martin Donlon to ask him if he agreed to let me do the port and
to get some information on how the SDL doc project currently works but
never got any answer.

so how’s the plan now?

I currently don’t have the time to do it on my own anymore, but if
someone volonteer for the job, I’ll gladly help with some code and/or
explanation on how SDL site works, if needed.

will the sdl doc be ported to the sdl main site?

I don’t know. I’d like it to be so, but…

do you need some one to do this?

I guess so, but I’d like to have some news from Martin Donlon too, since
I guess it would help the port quite a lot…

what’s there to be done?

If it’s to be migrated to the main site, here is how I would do it:

• define new tables in the SQL database to store the pages (possibly
  reusing the current table definition if the current pages are stored in
  a SQL database – which I don’t know). Alternatively, we could "store"
  the pages as html outside the database but, although this would probably
  lead to faster page generation, I don’t like the idea since it would
  reduce the possibilities.

• add Doc Project related privileges in the main site privilege table.

• write the PHP code (possibily only adapting the old code) to
  show/edit/add the documentation pages.

• insert the actual content into the new system by hand, or, preferably,
  using automated tools (if possible).

See you,
Gaetan.On Mon, 2004-02-09 at 22:27, Florian Hufsky wrote:

Sam Lantinga wrote:

On Tue, 2003-12-09 at 03:08, Sam Lantinga wrote:

Sam, you never told us your opinion on this topic, and I’d like to know
what you think…

Which topic?

SDLDoc maintainers… and the fact I’d like to include SDL doc on the
main website…

I like it, if it can be migrated over without too much hassle.
Martin, do you know what it would take to move the SDLdoc website
over to libsdl.org?

[John_Drinkwater]

I’m not sure if i’m talking out of place at all, so just hear me out…

I’ve been a newbie reading the SDL mailing list for about a year now, but never
been a frequent poster. What really helped in my development/hobby fiddling was
the SDL document project that had been setup.

Now to get to where i’m going…
Since just before this topic had come up, i’d been playing with using a Wiki*,
and had setup a basic system.
Over Christmas, I decided that since SDLdoc is loosing it’s manager, needs
updating, and requires an easier system to add the content; I started converting
some of the SDLdoc pages into Wiki, and modding the wiki system to accept the
requirements I wanted.
I’d tried contacting the current SDLdoc maintainer, but hadn’t had much luck, so
continued to do the odd bit every day.

It’s currently up at http://www.nextraweb.com/cgi-bin/SDLdoc
Have a look, have a comment, have a mock.
It is current open to abuse, so I ask that people be careful editing pages, but
just in case, I can revert to older copies

Does anyone have a problem with me taking over the doc project?, does anyone
want to help manage the site if we do?
Would people like to help populate the content, add more examples, or even help
adjust the UseMod code to our specific usages.

Cheers,
John

A Wiki, for those of you that dont know, is a freeform website.
Anyone can creat pages, edit pages, format pages. It doesnt use HTML, but a very
simple set of rules to format a page, you’ll learn in a few minutes …

[Currently my isp’s webserver is having an upgrade, so please excuse the odd
timeout]

Gaetan de Menten wrote:> On Mon, 2004-02-09 at 22:27, Florian Hufsky wrote:

i don’t know if this has been discussed any further (i’ve seen nothing).

No. Or well… Nothing that I’m aware of anyway. Back then, I tried to
contact Martin Donlon to ask him if he agreed to let me do the port and
to get some information on how the SDL doc project currently works but
never got any answer.

so how’s the plan now?

I currently don’t have the time to do it on my own anymore, but if
someone volonteer for the job, I’ll gladly help with some code and/or
explanation on how SDL site works, if needed.

will the sdl doc be ported to the sdl main site?

I don’t know. I’d like it to be so, but…

do you need some one to do this?

I guess so, but I’d like to have some news from Martin Donlon too, since
I guess it would help the port quite a lot…

what’s there to be done?

If it’s to be migrated to the main site, here is how I would do it:

• define new tables in the SQL database to store the pages (possibly
  reusing the current table definition if the current pages are stored in
  a SQL database – which I don’t know). Alternatively, we could "store"
  the pages as html outside the database but, although this would probably
  lead to faster page generation, I don’t like the idea since it would
  reduce the possibilities.

• add Doc Project related privileges in the main site privilege table.

• write the PHP code (possibily only adapting the old code) to
  show/edit/add the documentation pages.

• insert the actual content into the new system by hand, or, preferably,
  using automated tools (if possible).

See you,
Gaetan.

Sam Lantinga wrote:

On Tue, 2003-12-09 at 03:08, Sam Lantinga wrote:

Sam, you never told us your opinion on this topic, and I’d like to know
what you think…

Which topic?

SDLDoc maintainers… and the fact I’d like to include SDL doc on the
main website…

I like it, if it can be migrated over without too much hassle.
Martin, do you know what it would take to move the SDLdoc website
over to libsdl.org?

---

SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

-------------- next part --------------
A non-text attachment was scrubbed…
Name: not available
Type: application/pgp-signature
Size: 250 bytes
Desc: not available
URL: http://lists.libsdl.org/pipermail/sdl-libsdl.org/attachments/20040209/5eae4098/attachment.pgp

[Julien_Pauty]

I have looked quickly, i find this rather cool. I like the idea of the
Wiki. It could permit to people to add doc more easily. Like new faq or
link to classical tutorials. In fact the examples data base could also
grow more quickly.

Julien

John Drinkwater wrote:> I’m not sure if i’m talking out of place at all, so just hear me out…

I’ve been a newbie reading the SDL mailing list for about a year now,
but never been a frequent poster. What really helped in my
development/hobby fiddling was the SDL document project that had been
setup.

Now to get to where i’m going…
Since just before this topic had come up, i’d been playing with using
a Wiki*, and had setup a basic system.
Over Christmas, I decided that since SDLdoc is loosing it’s manager,
needs updating, and requires an easier system to add the content; I
started converting some of the SDLdoc pages into Wiki, and modding the
wiki system to accept the requirements I wanted.
I’d tried contacting the current SDLdoc maintainer, but hadn’t had
much luck, so continued to do the odd bit every day.

It’s currently up at http://www.nextraweb.com/cgi-bin/SDLdoc
Have a look, have a comment, have a mock.
It is current open to abuse, so I ask that people be careful editing
pages, but just in case, I can revert to older copies

Does anyone have a problem with me taking over the doc project?, does
anyone want to help manage the site if we do?
Would people like to help populate the content, add more examples, or
even help adjust the UseMod code to our specific usages.

Cheers,
John

[Florian_Hufsky]

what about merging this with the sdl doc (keeping the wiki format) and
integrating it int the main sdl page?

Julien Pauty wrote:> I have looked quickly, i find this rather cool. I like the idea of the

Wiki. It could permit to people to add doc more easily. Like new faq
or link to classical tutorials. In fact the examples data base could
also grow more quickly.

Julien

John Drinkwater wrote:

I’m not sure if i’m talking out of place at all, so just hear me out…

I’ve been a newbie reading the SDL mailing list for about a year now,
but never been a frequent poster. What really helped in my
development/hobby fiddling was the SDL document project that had been
setup.

Now to get to where i’m going…
Since just before this topic had come up, i’d been playing with using
a Wiki*, and had setup a basic system.
Over Christmas, I decided that since SDLdoc is loosing it’s manager,
needs updating, and requires an easier system to add the content; I
started converting some of the SDLdoc pages into Wiki, and modding
the wiki system to accept the requirements I wanted.
I’d tried contacting the current SDLdoc maintainer, but hadn’t had
much luck, so continued to do the odd bit every day.

It’s currently up at http://www.nextraweb.com/cgi-bin/SDLdoc
Have a look, have a comment, have a mock.
It is current open to abuse, so I ask that people be careful editing
pages, but just in case, I can revert to older copies

Does anyone have a problem with me taking over the doc project?, does
anyone want to help manage the site if we do?
Would people like to help populate the content, add more examples, or
even help adjust the UseMod code to our specific usages.

Cheers,
John

---

SDL mailing list
SDL at libsdl.org
http://www.libsdl.org/mailman/listinfo/sdl

[slouken]

what about merging this with the sdl doc (keeping the wiki format) and
integrating it int the main sdl page?

Possibly. Let’s get the new website up first.

See ya!
-Sam Lantinga, Software Engineer, Blizzard Entertainment

[Julien_Pauty]

Florian Hufsky wrote:

what about merging this with the sdl doc (keeping the wiki format) and
integrating it int the main sdl page?

For me, it is a good idea. It is quite logical to have the doc on the
same Web site as the library.

Julien