Welcome

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

Welcome

#1 Post by puppian »

Welcome!

So happy to meet everyone here 8)
We'll be discussing everything about puppy docs :D

Some general info:

Please add your docs to http://puppylinux.org/docs/pre
Just click the Login link (see left column) to start editing. Password: pldp
You can use this sandbox page to practice your editing skills.

When the documentation is almost finished the whole site will be moved to http://puppylinux.org/docs and continue to be maintained by the documentation committee.


To create a new page, just edit any existing page and add the name of your new page at the end. Then, highlight that newly added line and click the H1 button (for sub-menu click H2 or H3). Finally click the 'save' button (the floppy icon) and the link to your new page will appear in the left pane. Multiple pages can be created at one time using this method. To delete a page, edit it and delete everything in it, then click 'save'. Must read:
User's Manual
Creating your pages
How to do common task
Writing your first pages

Image

And here's the tree structure.

Btw please use this template to write your page :)
http://puppylinux.org/docs/pre/?TEMPLATE
Last edited by puppian on Thu 08 Dec 2005, 18:13, edited 1 time in total.
[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

Great!

#2 Post by raffy »

Great work, Puppian! As soon as the CMS decision is taken, we can also begin testing the installation.

(Note: "we" is a way of speaking - it means "you with some help from us" :) )

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

#3 Post by J_Rey »

Well, it looks like now we're contributing to http://puppylinux.org/docs/ instead of using the preview site. :?

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

#4 Post by puppian »

Below is the understanding so far. Hope it helps :)
As to the link to /docs, it seems that the way cmsimple manage docs is more flexible and easy to navigate. Everything is in one large file which can be downloaded for offline viewing and can be converted to pdf file easily. So we can have it there for people to who want to view html online, and when the docs are almost finished, we can also convert it to pdf, and put a link in the 'Downloads' section for people to download it (just like what the php-fusion website did themselves), and could have version updates too (e.g. docsPuppy105.pdf, docsPuppy109.pdf, etc). This way different people who prefer different formats would be happy :)

The 'Articles' section at /docs/pup can be kept simple, mainly for stuff like handbook, mini-howto and quick guides :) So cmsimple would be for official stable docs only, while php-fusion will have everything else :) (btw will try to make the cmsimple theme looks more like the php-fusion one)

In fact some other linux distros are using standards like docbook xml to manage their docs (which are more complex and takes much more time to manage), but as our docs project is just a start (still an infant ;) ), I guess it's best to keep it simple now.
So just continue your initial writings for pldp at http://puppylinux.org/docs/pre , and when the docs are almost finished they will be moved to http://puppylinux.org/docs/ :)

PS. raffy has done some really great editing to /docs/pup, take a look!
[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

#5 Post by mayakovski »

Ok, so can someone provide a diffinative answer.

Are we using /docs or /docs/pre?

I personally think it makes sense to use /docs and just work there in the main area. That way it is more incentive to be quick, efficient and accurate. But I will take my ques from you folks who are by far the more senior puppies.

Me, I'm just a baby puppy. :)
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 I should have written it this way :)

So just continue your initial writings for pldp at http://puppylinux.org/docs/pre, and finished pages will be moved to http://puppylinux.org/docs/

docs/pre is used for initial writings, for example, sometimes I can't finish a whole page, but just half of it, and it's better to leave it at docs/pre, so our new puppy user won't see a halfly finished page (which may also contain incorrect information since proofreading hasn't been done yet) :)
Also, docs/pre is accessible by everyone and so we can have contributions from different people, which can be then proofread by the docs committee :)
[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 »

Thanks Puppian;

That makes it very clear to me, it makes sense too.
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

Post Reply