Attribution; what do you think?

Helping keep Puppy well documented
Post Reply
Message
Author
User avatar
puppian
Posts: 537
Joined: Tue 19 Jul 2005, 03:58
Location: PuppyLand
Contact:

Attribution; what do you think?

#1 Post by puppian »

This post about 'reward' reminds me this. Should we let people include their name and email in the docs they wrote, like what the Linux documentation project does?
For example,
http://www.tldp.org/docs.html#howto
http://www.ibiblio.org/pub/Linux/docs/H ... ml_single/
http://www.ibiblio.org/pub/Linux/docs/H ... Mouse.html

Contributors who aren't joining the docs committee may want their name appear somewhere :)

Btw, I think I have seen in other docs project something like 'these docs are under xxx license'. I'm no good at that, so do we need that?
[url=http://puppylinux.org]Puppylinux.org - Community home page of Puppy Linux[/url] hosted by Barry (creator of Puppy), created and maintained by the [url=http://puppylinux.org/user/readarticle.php?article_id=8]Puppy Linux Foundation[/url] since 2005

User avatar
Ian
Official Dog Handler
Posts: 1234
Joined: Wed 04 May 2005, 12:00
Location: Queensland

#2 Post by Ian »

Yes I think credit should be given to all who contribute to this project.
And I'm not sure about the license part.

User avatar
J_Rey
Posts: 273
Joined: Wed 04 May 2005, 20:08
Location: Northwest Florida, U.S.A.
Contact:

+1

#3 Post by J_Rey »

Yesterday I spent a few hours categorizing the wiki (mostly done) to make it easier to find things for referring to when creating documentation pages (in addition to the Sitemap). Also, I submitted the CategoryDocumentation wiki page to DistroWatch until our site is ready (people are already visiting there). So my categorizing the pages had another specific purpose.

I was thinking about, for my contribution, eventually starting out with having a related links/contributors section at the bottom of each documentation page that has links to related wiki, pupweb, and forum pages (and other sources like Barry's offline Help pages included with Puppy) that would be helpful for anyone to refer to when creating pages, and also would serve to show where the source of the info was and also include the authors in some way. We should have a standard template/format for this and the other page sections also.

brad_chuck
Posts: 286
Joined: Tue 16 Aug 2005, 03:47
Location: Appalachian Mountains

A Thought

#4 Post by brad_chuck »

What about letting people put there name after the part they write and then making that a link to a page that tells the emails of all the people that contributed.

This would be great for people that would like to add more than there email(websites or AIM). Or if there email changed they would not have to look up all the pages they edited they could just edit the one page with the names on it.

User avatar
mayakovski
Posts: 124
Joined: Sun 20 Nov 2005, 00:42
Location: Comox, BC, CANADA

#5 Post by mayakovski »

Hi All;

These are all great ideas and thoughts.

One issue I can see is how do you deal with documentation that is a derivative of someone else's original work? I am currently working on putting some docs into the install section but they are my rewording (mostly) of other docs in the HowTo section of the forum.

At what point do my changes make the document my own? Similar to the issue artists and musicians often have when creating work from other peoples work.

Maybe listing the names, if known, of all people who had a hand in the original work. Some kind of sudo credit/disclaimer at the bottom of each document. IE.

"This document is a collection of ideas and knowledge contributed to by blah, blah, blah."
Puppy Linux Documentation Project.

This works both ways, if you and only you created the document then yours is the only name listed. Otherwise any known people are listed. We could also have a disclaimer listed somewhere stating that if you find documentation that you contributed to and you are not listed, provide us with an example proving you created part of the work and we will add you in to the list, baring that we could just rewrite that section.
Mayakovski
**********************
Puppy Linux | Barking Up The Right Tree

Compaq Armada 1580DMT | P150, 49MB RAM - 3.2 GB HD, Puppy 1.0.6
Compaq Deskpro EN | P3-733, 384 MB RAM - 80GB HD, Puppy 1.0.7

User avatar
puppian
Posts: 537
Joined: Tue 19 Jul 2005, 03:58
Location: PuppyLand
Contact:

#6 Post by puppian »

>Maybe listing the names, if known, of all people who had a hand in the original work. Some kind of sudo credit/disclaimer at the bottom of each document. IE.

How about something like this :)

Title of the docs page
Name of author, Contact method(s)

Content
Content

Page last edited by AAA, Contact method(s), 27 Nov 2005.

References:
Forum post A by user XX - some descriptions if needed.
Article B by user YY - some descriptions if needed.
[url=http://puppylinux.org]Puppylinux.org - Community home page of Puppy Linux[/url] hosted by Barry (creator of Puppy), created and maintained by the [url=http://puppylinux.org/user/readarticle.php?article_id=8]Puppy Linux Foundation[/url] since 2005

User avatar
mayakovski
Posts: 124
Joined: Sun 20 Nov 2005, 00:42
Location: Comox, BC, CANADA

#7 Post by mayakovski »

puppian wrote: Title of the docs page
Name of author, Contact method(s)

Content
Content

Page last edited by AAA, Contact method(s), 27 Nov 2005.

References:
Forum post A by user XX - some descriptions if needed.
Article B by user YY - some descriptions if needed.
I think that works quite well, it seems to cover the bases and is elegant as well. I think that would keep everyone happy. It gets my vote. :D
Mayakovski
**********************
Puppy Linux | Barking Up The Right Tree

Compaq Armada 1580DMT | P150, 49MB RAM - 3.2 GB HD, Puppy 1.0.6
Compaq Deskpro EN | P3-733, 384 MB RAM - 80GB HD, Puppy 1.0.7

User avatar
puppian
Posts: 537
Joined: Tue 19 Jul 2005, 03:58
Location: PuppyLand
Contact:

#8 Post by puppian »

I have added the things mentioned above to this page:
http://puppylinux.org/docs/pre/?Getting ... gers:IceWM
(that page was written long time ago and I can't remember the references :oops:)

Is everyone ok with that? If so, I'll be making a new thread to tell people about this so that those who aren't joining the committee but still want to contribute will know how to include their names, etc :)
[url=http://puppylinux.org]Puppylinux.org - Community home page of Puppy Linux[/url] hosted by Barry (creator of Puppy), created and maintained by the [url=http://puppylinux.org/user/readarticle.php?article_id=8]Puppy Linux Foundation[/url] since 2005

User avatar
mayakovski
Posts: 124
Joined: Sun 20 Nov 2005, 00:42
Location: Comox, BC, CANADA

#9 Post by mayakovski »

Looks good to me.

I'll start using this format today. I think this will keep everyone happy. And isn't that one of the best things about puppies...
Mayakovski
**********************
Puppy Linux | Barking Up The Right Tree

Compaq Armada 1580DMT | P150, 49MB RAM - 3.2 GB HD, Puppy 1.0.6
Compaq Deskpro EN | P3-733, 384 MB RAM - 80GB HD, Puppy 1.0.7

User avatar
Flash
Official Dog Handler
Posts: 13071
Joined: Wed 04 May 2005, 16:04
Location: Arizona USA

#10 Post by Flash »

puppian wrote:...I'll be making a new thread to tell people about this so that those who aren't joining the committee but still want to contribute will know how to include their names, etc :)
Remember that only PLDP Usergroup members can view the PLDP forum.

User avatar
puppian
Posts: 537
Joined: Tue 19 Jul 2005, 03:58
Location: PuppyLand
Contact:

#11 Post by puppian »

Thanks Flash :D
yes that new thread would be in the 'Puppy Power' forum.
[url=http://puppylinux.org]Puppylinux.org - Community home page of Puppy Linux[/url] hosted by Barry (creator of Puppy), created and maintained by the [url=http://puppylinux.org/user/readarticle.php?article_id=8]Puppy Linux Foundation[/url] since 2005

User avatar
puppian
Posts: 537
Joined: Tue 19 Jul 2005, 03:58
Location: PuppyLand
Contact:

#12 Post by puppian »

The final template is here :)

http://www.murga.org/~puppy/viewtopic.php?t=4372

It's also in the sticky welcome post of this forum.
[url=http://puppylinux.org]Puppylinux.org - Community home page of Puppy Linux[/url] hosted by Barry (creator of Puppy), created and maintained by the [url=http://puppylinux.org/user/readarticle.php?article_id=8]Puppy Linux Foundation[/url] since 2005

raffy
Posts: 4798
Joined: Wed 25 May 2005, 12:20
Location: Manila

Template

#13 Post by raffy »

Hope that template is also available at the DOCS site :)

User avatar
puppian
Posts: 537
Joined: Tue 19 Jul 2005, 03:58
Location: PuppyLand
Contact:

#14 Post by puppian »

[url=http://puppylinux.org]Puppylinux.org - Community home page of Puppy Linux[/url] hosted by Barry (creator of Puppy), created and maintained by the [url=http://puppylinux.org/user/readarticle.php?article_id=8]Puppy Linux Foundation[/url] since 2005

Post Reply