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 Mon 22 Sep 2014, 12:18
All times are UTC - 4
 Forum index » Taking the Puppy out for a walk » Puppy Power
Documentation
Moderators: Flash, JohnMurga
Post new topic   Reply to topic View previous topic :: View next topic
Page 1 of 1 [6 Posts]  
Author Message
raffy

Joined: 25 May 2005
Posts: 4765
Location: Manila

PostPosted: Mon 03 Oct 2005, 18:58    Post subject:  Documentation  

Puppy has a wealth of documentation, such as the Beginner's section sticky posts by Flash and Lobster, and pages by many others in the Wiki (sorry, Wiki is down now, so can't produce the links). However, we may have to write/rewrite the pages and organize it into a tree (hierarchy). Any suggestions on how to do this?

We can use this documentation tree in putting up the new Wiki. Thanks!

Last edited by raffy on Mon 03 Oct 2005, 23:48; edited 1 time in total
Back to top
View user's profile Send private message 
Flash
Official Dog Handler


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

PostPosted: Mon 03 Oct 2005, 23:45    Post subject:  

Not to discourage, but who would keep the thing up-to-date? I can tell you from my experience with the sticky indexes, that's not a trivial job for one person. Yet, if it's not done the whole project becomes useless. The sticky indexes are not as ambitious as what you seem to propose.
Back to top
View user's profile Send private message 
Ian
Official Dog Handler


Joined: 04 May 2005
Posts: 1237
Location: Queensland

PostPosted: Tue 04 Oct 2005, 00:03    Post subject:  

This is where the Foundation could come into play by helping to organize a Puppy Documentation team the same as other organizations have.

If you start a Puppy Documentation Project I am sure people will be willing to help out, it just needs to be split into sections and the various sections organised into the documentation required for each section.

When a section is finished it only needs to be upgraded to keep it current, which could be done once a month if required.
Back to top
View user's profile Send private message 
Lobster
Official Crustacean


Joined: 04 May 2005
Posts: 15117
Location: Paradox Realm

PostPosted: Tue 04 Oct 2005, 03:29    Post subject:  

The Founders and Trustees
needs combining - started the process for some kind Puppy with the friskiness to finish . . .
http://www.goosee.com/puppy/wikka/FoundationPuppy

Puppy promotion week - I have released a lot of the Puppy wiki pages for people to adopt. If you wish to adopt a puppy page - please do so or start editing so your interest becomes apparant

Look in Start / Help and see what pages need work - tell everyone - provide it as a wiki page, HTML or straight text

_________________
Puppy WIKI

Last edited by Lobster on Sun 23 Oct 2005, 02:01; edited 2 times in total
Back to top
View user's profile Send private message Visit poster's website 
puppian


Joined: 18 Jul 2005
Posts: 538
Location: PuppyLand

PostPosted: Tue 04 Oct 2005, 06:02    Post subject: Re: Documentation  

raffy wrote:
Puppy has a wealth of documentation, such as the Beginner's section sticky posts by Flash and Lobster, and pages by many others in the Wiki (sorry, Wiki is down now, so can't produce the links). However, we may have to write/rewrite the pages and organize it into a tree (hierarchy). Any suggestions on how to do this?

We can use this documentation tree in putting up the new Wiki. Thanks!

Yes we surely need that Smile
My suggestion for the documentation tree would be something like this:
http://www.goosee.com/puppy/wikka/SiteMap ,or
http://www.goosee.com/puppy/wikka/install

Quote:
When a section is finished it only needs to be upgraded to keep it current, which could be done once a month if required.

I'm doing that for the SiteMap page. And I agree with Flash that it's not a trivial job for one person. It's so because we are talking about a Wiki, which people are constantly adding content to it, just like here on the forum. It's easy to overlook a newly created page (I just find that I haven't add the OnlineResource page to the SiteMap page in my last update Embarassed). The good news is that we have a PageIndex page in the wiki. One will know what pages have been created if he save a copy of that page to his computer regularly and then compare their difference (using Gtkdiff in Puppy). That's how I did it, still overlooked something though...Embarassed

A way to make thing easier maybe combining the above mentioned tree system with the Category system of Wikka Wakka:
http://www.goosee.com/puppy/wikka/WikiCategory

# The master list of the categories is Category Category (without the space) which will automatically list all known maincategories, and should never be edited. This list is easily accessed from the Wiki's top navigation bar. (Categories).

# Each category has a WikiName name of the form CategoryName for example CategoryWiki etc. (see list of maincategories above)

# Pages can belong to zero or more categories. Including a page in a category is done by simply mentioning the CategoryName on the page (by convention at the very end of the page).

# The system allows to build hierarchies of categories by referring to the parent category in the subcategory page. The parent category page will then automatically include the subcategory page in its list. ....

The idea is good as it's easy for people who created the page to add it to the category they think appropriate, just add a link and all is done (and the best too, as they're the person who knows what the page is all about).
I think there's been some efforts (by G2 I guess?) implementing that to Puppy Wiki. That doesn't work very well though because either people is not adding their page to the category, or they all add their page to CategoryDocumentation Smile

I think that's so because we didn't have much pages when the wiki just start and so no sub-categories are created. Also the idea that "everyone can help things organized by adding a link to their page" is not comunicated very well to everyone Wink However, even with this category system some mainteinance is still needed, to correct pages that're put in the wrong categories, to add pages in case they're not added by the page owner, to create new (sub)categories, etc.

_________________
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 
J_Rey


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

PostPosted: Sun 23 Oct 2005, 01:33    Post subject: +1  

Yes, this has been/is needed. Otherwise we will continue to have repetitive support requests and unnecessary learning of how not to do things. Organization, organization, organization! Let's not forget to include Barry's web pages about how puppy works, faq page, snippets from the developer's news page, and others. I help here and there with this but there's only so much time. So, now, we make a plan, delegate responsiblities, and get going! Volunteers welcome here and with most everything Puppy!
Back to top
View user's profile Send private message Visit poster's website AIM Address Yahoo Messenger 
Display posts from previous:   Sort by:   
Page 1 of 1 [6 Posts]  
Post new topic   Reply to topic View previous topic :: View next topic
 Forum index » Taking the Puppy out for a walk » Puppy Power
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.0627s ][ Queries: 12 (0.0037s) ][ GZIP on ]