Puppy Linux Discussion Forum Forum Index Puppy Linux Discussion Forum
Puppy HOME page : puppylinux.com
"THE" alternative forum : puppylinux.info
 
 FAQFAQ   SearchSearch   MemberlistMemberlist   UsergroupsUsergroups   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

The time now is Wed 30 Jul 2014, 19:55
All times are UTC - 4
 Forum index » Advanced Topics » Puppy Projects » Documentation Project
Attribution; what do you think?
Moderators: Flash, JohnMurga, puppian
Post new topic   Reply to topic View previous topic :: View next topic
Page 1 of 1 [14 Posts]  
Author Message
puppian


Joined: 18 Jul 2005
Posts: 538
Location: PuppyLand

PostPosted: Sat 19 Nov 2005, 11:39    Post subject:  Attribution; what do you think?  

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/HOWTO/other-formats/html_single/
http://www.ibiblio.org/pub/Linux/docs/HOWTO/other-formats/html_single/3-Button-Mouse.html

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

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?

_________________
Puppylinux.org - Community home page of Puppy Linux hosted by Barry (creator of Puppy), created and maintained by the Puppy Linux Foundation since 2005
Back to top
View user's profile Send private message Visit poster's website 
Ian
Official Dog Handler


Joined: 04 May 2005
Posts: 1237
Location: Queensland

PostPosted: Sun 20 Nov 2005, 18:32    Post subject:  

Yes I think credit should be given to all who contribute to this project.
And I'm not sure about the license part.
Back to top
View user's profile Send private message 
J_Rey


Joined: 04 May 2005
Posts: 276
Location: Northwest Florida, U.S.A.

PostPosted: Sun 20 Nov 2005, 20:52    Post subject: +1  

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.
Back to top
View user's profile Send private message Visit poster's website AIM Address Yahoo Messenger 
brad_chuck

Joined: 15 Aug 2005
Posts: 284
Location: Appalachian Mountains

PostPosted: Mon 21 Nov 2005, 13:31    Post subject: A Thought  

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.
Back to top
View user's profile Send private message 
mayakovski


Joined: 19 Nov 2005
Posts: 124
Location: Comox, BC, CANADA

PostPosted: Sat 26 Nov 2005, 14:00    Post subject:  

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
Back to top
View user's profile Send private message 
puppian


Joined: 18 Jul 2005
Posts: 538
Location: PuppyLand

PostPosted: Sat 26 Nov 2005, 15:40    Post subject:  

>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 Smile

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.

_________________
Puppylinux.org - Community home page of Puppy Linux hosted by Barry (creator of Puppy), created and maintained by the Puppy Linux Foundation since 2005
Back to top
View user's profile Send private message Visit poster's website 
mayakovski


Joined: 19 Nov 2005
Posts: 124
Location: Comox, BC, CANADA

PostPosted: Sat 26 Nov 2005, 15:47    Post subject:  

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. Very Happy

_________________
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
Back to top
View user's profile Send private message 
puppian


Joined: 18 Jul 2005
Posts: 538
Location: PuppyLand

PostPosted: Tue 29 Nov 2005, 14:42    Post subject:  

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

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 Smile

_________________
Puppylinux.org - Community home page of Puppy Linux hosted by Barry (creator of Puppy), created and maintained by the Puppy Linux Foundation since 2005
Back to top
View user's profile Send private message Visit poster's website 
mayakovski


Joined: 19 Nov 2005
Posts: 124
Location: Comox, BC, CANADA

PostPosted: Tue 29 Nov 2005, 14:54    Post subject:  

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
Back to top
View user's profile Send private message 
Flash
Official Dog Handler


Joined: 04 May 2005
Posts: 10948
Location: Arizona USA

PostPosted: Tue 29 Nov 2005, 17:00    Post subject:  

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 Smile
Remember that only PLDP Usergroup members can view the PLDP forum.
Back to top
View user's profile Send private message 
puppian


Joined: 18 Jul 2005
Posts: 538
Location: PuppyLand

PostPosted: Wed 30 Nov 2005, 04:28    Post subject:  

Thanks Flash Very Happy
yes that new thread would be in the 'Puppy Power' forum.

_________________
Puppylinux.org - Community home page of Puppy Linux hosted by Barry (creator of Puppy), created and maintained by the Puppy Linux Foundation since 2005
Back to top
View user's profile Send private message Visit poster's website 
puppian


Joined: 18 Jul 2005
Posts: 538
Location: PuppyLand

PostPosted: Wed 07 Dec 2005, 15:49    Post subject:  

The final template is here Smile

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

It's also in the sticky welcome post of this forum.

_________________
Puppylinux.org - Community home page of Puppy Linux hosted by Barry (creator of Puppy), created and maintained by the Puppy Linux Foundation since 2005
Back to top
View user's profile Send private message Visit poster's website 
raffy

Joined: 25 May 2005
Posts: 4759
Location: Manila

PostPosted: Wed 07 Dec 2005, 19:16    Post subject: Template  

Hope that template is also available at the DOCS site Smile
Back to top
View user's profile Send private message 
puppian


Joined: 18 Jul 2005
Posts: 538
Location: PuppyLand

PostPosted: Thu 08 Dec 2005, 14:14    Post subject:  

Sure!

http://puppylinux.org/docs/pre/?TEMPLATE

Very Happy

_________________
Puppylinux.org - Community home page of Puppy Linux hosted by Barry (creator of Puppy), created and maintained by the Puppy Linux Foundation since 2005
Back to top
View user's profile Send private message Visit poster's website 
Display posts from previous:   Sort by:   
Page 1 of 1 [14 Posts]  
Post new topic   Reply to topic View previous topic :: View next topic
 Forum index » Advanced Topics » Puppy Projects » Documentation Project
Jump to:  

You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum
You cannot attach files in this forum
You can download files in this forum


Powered by phpBB © 2001, 2005 phpBB Group
[ Time: 0.0810s ][ Queries: 12 (0.0118s) ][ GZIP on ]